Enlaces

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

Punto final API:

GET 
https://m.ideesmx.net/api/v1/links

Ejemplo de solicitud: 

curl --location --request GET 'https://m.ideesmx.net/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. Por defecto es: title.
status
opcional integer
Filtrar por estado. Los valores posibles son: 0 para Todos, 1 para Activo, 2 para Expirado, 3 para Deshabilitado. Por defecto es: 0.
space_id
opcional integer
Filtrar por ID de Categoría.
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. Por defecto es: id.
sort
opcional string
Ordenar. Los valores posibles son: desc para Descendente, asc para Ascendente. Por defecto es: desc.
per_page
opcional integer
Resultados por página. Los valores posibles son: 10, 25, 50, 100. Por defecto es: 25.
Mostrar

Punto final API:

GET 
https://m.ideesmx.net/api/v1/links/{id}

Ejemplo de solicitud: 

curl --location --request GET 'https://m.ideesmx.net/api/v1/links/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Guardar

Punto final API:

POST 
https://m.ideesmx.net/api/v1/links

Ejemplo de solicitud: 

curl --location --request POST 'https://m.ideesmx.net/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 a acortar.
domain_id
requerido integer
El ID del dominio en el que 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 Categoría en el que 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 Deshabilitado. Por defecto es: 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. Por defecto es: 0.
privacy_password
opcional string
La contraseña para la página de estadísticas. Solo funciona con privacy configurado en 2.
expiration_url
opcional string
El enlace al que el usuario será redirigido una vez que el enlace haya expirado.
expiration_date
opcional string
La fecha de expiración del enlace en el formato YYYY-MM-DD.
expiration_time
opcional string
La hora de expiración del enlace en el formato HH:MM.
expiration_clicks
opcional integer
El número de clics después de los cuales el enlace debería expirar.
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 el usuario será redirigido.
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 el usuario será redirigido.
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 el usuario será redirigido.
rotation[index][value]
opcional string
El enlace al que el usuario será redirigido.
Actualizar

Punto final API:

PUT PATCH 
https://m.ideesmx.net/api/v1/links/{id}

Ejemplo de solicitud: 

curl --location --request PUT 'https://m.ideesmx.net/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 a acortar.
alias
opcional string
El alias del enlace.
password
opcional string
La contraseña del enlace.
space_id
opcional integer
El ID del Categoría en el que 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 Deshabilitado.
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 en 2.
expiration_url
opcional string
El enlace al que el usuario será redirigido una vez que el enlace haya expirado.
expiration_date
opcional string
La fecha de expiración del enlace en el formato YYYY-MM-DD.
expiration_time
opcional string
La hora de expiración del enlace en el formato HH:MM.
expiration_clicks
opcional integer
El número de clics después de los cuales el enlace debería expirar.
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 el usuario será redirigido.
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 el usuario será redirigido.
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 el usuario será redirigido.
rotation[index][value]
opcional string
El enlace al que el usuario será redirigido.
Eliminar

Punto final API:

DELETE 
https://m.ideesmx.net/api/v1/links/{id}

Ejemplo de solicitud: 

curl --location --request DELETE 'https://m.ideesmx.net/api/v1/links/{id}' \
--header 'Authorization: Bearer {api_key}'