Enlaces

Notas
Nivel experto
La clave de API debe enviarse como un token Bearer en el encabezado de autorización de la solicitud. Obtén tu clave de API.
Lista

Punto final de la API:

GET 
http://link.platform.cl/api/v1/links

Ejemplo de solicitud: 

curl --location --request GET 'http://link.platform.cl/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parámetro
Tipo
Descripción
search
opcional string
La consulta de búsqueda.
search_by
opcional string
Buscar por. Los valores posibles son: title para Título, alias para Alias, url para URL. Predeterminado: title.
status
opcional integer
Filtrar por estado. Los valores posibles son: 0 para Todos, 1 para Activo, 2 para Caducado, 3 para Desactivado. Predeterminado: 0.
space_id
opcional integer
Filtrar por ID de espacio.
domain_id
opcional integer
Filtrar por ID de dominio.
pixel_id
opcional integer
Filtrar por ID de píxel.
sort_by
opcional string
Ordenar por. Los valores posibles son: id para Fecha de creación, clicks para Clics, title para Título, alias para Alias, url para URL. Predeterminado: id.
sort
opcional string
Ordenar. Los valores posibles son: desc para Descendente, asc para Ascendente. Predeterminado: desc.
per_page
opcional int
Resultados por página. Los valores posibles son: 10, 25, 50, 100. Predeterminado: 10.
Mostrar

Punto final de la API:

GET 
http://link.platform.cl/api/v1/links/{id}

Ejemplo de solicitud: 

curl --location --request GET 'http://link.platform.cl/api/v1/links/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Almacenar

Punto final de la API:

POST 
http://link.platform.cl/api/v1/links

Ejemplo de solicitud: 

curl --location --request POST 'http://link.platform.cl/api/v1/links' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}' \
--data-urlencode 'domain={id}'
Parámetro
Tipo
Descripción
url
requerido string
El enlace que se acortará.
domain_id
requerido integer
El ID del dominio donde se guardará el enlace.
alias
opcional string
El alias del enlace.
password
opcional string
La contraseña del enlace.
space_id
opcional integer
El ID del espacio donde se guardará el enlace.
pixel_ids
opcional array
The pixel IDs to be integrated in the link.
disabled
opcional integer
Si el enlace está deshabilitado o no. Los valores posibles son: 0 para Activo, 1 para Desactivado. Predeterminado: 0.
privacy
opcional integer
Si las estadísticas del enlace son públicas o no. Los valores posibles son: 0 para Público, 1 para Privado, 2 para Contraseña. Predeterminado: 0.
privacy_password
opcional string
La contraseña para la página de estadísticas. Solo funciona con privacy configurado como 2.
expiration_url
opcional string
El enlace al que se redirigirá al usuario una vez que el enlace haya caducado.
expiration_date
opcional string
La fecha de caducidad del enlace en formato YYYY-MM-DD.
expiration_time
opcional string
La hora de caducidad del enlace en formato HH:MM.
expiration_clicks
opcional integer
El número de clics después de los cuales el enlace debería caducar.
target_type
opcional integer
El tipo de segmentación. Los valores posibles son: 0 para Ninguno, 1 para Geográfico, 2 para Plataforma, 4 para Rotación.
country[index][key]
opcional string
El código del país objetivo. El código debe estar en el estándar ISO 3166-1 alpha-2.
country[index][value]
opcional string
El enlace al que se redirigirá al usuario.
platform[index][key]
opcional string
El nombre de la plataforma objetivo. Los valores posibles son: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
opcional string
El enlace al que se redirigirá al usuario.
language[index][key]
opcional string
El código del idioma objetivo. El código debe estar en el estándar ISO 639-1 alpha-2.
language[index][value]
opcional string
El enlace al que se redirigirá al usuario.
rotation[index][value]
opcional string
El enlace al que se redirigirá al usuario.
Actualizar

Punto final de la API:

PUT PATCH 
http://link.platform.cl/api/v1/links/{id}

Ejemplo de solicitud: 

curl --location --request PUT 'http://link.platform.cl/api/v1/links/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Parámetro
Tipo
Descripción
url
opcional string
El enlace que se acortará.
alias
opcional string
El alias del enlace.
password
opcional string
La contraseña del enlace.
space_id
opcional integer
El ID del espacio donde se guardará el enlace.
pixel_ids
opcional array
The pixel IDs to be integrated in the link.
disabled
opcional integer
Si el enlace está deshabilitado o no. Los valores posibles son: 0 para Activo, 1 para Desactivado.
privacy
opcional integer
Si las estadísticas del enlace son públicas o no. Los valores posibles son: 0 para Público, 1 para Privado, 2 para Contraseña.
privacy_password
opcional string
La contraseña para la página de estadísticas. Solo funciona con privacy configurado como 2.
expiration_url
opcional string
El enlace al que se redirigirá al usuario una vez que el enlace haya caducado.
expiration_date
opcional string
La fecha de caducidad del enlace en formato YYYY-MM-DD.
expiration_time
opcional string
La hora de caducidad del enlace en formato HH:MM.
expiration_clicks
opcional integer
El número de clics después de los cuales el enlace debería caducar.
target_type
opcional integer
El tipo de segmentación. Los valores posibles son: 0 para Ninguno, 1 para Geográfico, 2 para Plataforma, 4 para Rotación.
country[index][key]
opcional string
El código del país objetivo. El código debe estar en el estándar ISO 3166-1 alpha-2.
country[index][value]
opcional string
El enlace al que se redirigirá al usuario.
platform[index][key]
opcional string
El nombre de la plataforma objetivo. Los valores posibles son: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
opcional string
El enlace al que se redirigirá al usuario.
language[index][key]
opcional string
El código del idioma objetivo. El código debe estar en el estándar ISO 639-1 alpha-2.
language[index][value]
opcional string
El enlace al que se redirigirá al usuario.
rotation[index][value]
opcional string
El enlace al que se redirigirá al usuario.
Eliminar

Punto final de la API:

DELETE 
http://link.platform.cl/api/v1/links/{id}

Ejemplo de solicitud: 

curl --location --request DELETE 'http://link.platform.cl/api/v1/links/{id}' \
--header 'Authorization: Bearer {api_key}'