Desarrolladores

Notas
La clave de API debe enviarse como un token de portador en el encabezado Authorization de la solicitud. Obtenga su clave de API.
Listar

Listar todos los enlaces.

API Cliente:

GET
http://hx2.xyz/api/v1/links

Ejemplo de requisito:

curl --location --request GET 'http://hx2.xyz/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Mostrar

Solicita detalles de un enlace.

API Cliente:

GET
http://hx2.xyz/api/v1/links/{id}

Ejemplo de requisito:

curl --location --request GET 'http://hx2.xyz/api/v1/links/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Almacen

Crea un enlace.

API Cliente:

POST
http://hx2.xyz/api/v1/links

Ejemplo de requisito:

curl --location --request POST 'http://hx2.xyz/api/v1/links' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Parámetro
Tipo
Descripción
url
requerido string
El enlace a organizar.
alias
opcional string
El alias de enlace.
password
opcional string
La contraseña del enlace.
space
opcional integer
El espacio es el enlace para guardar en.
domain
opcional integer
El dominio es el enlace que se guardará en.
disabled
opcional integer
Si el enlace está deshabilitado o no, el valor predeterminado es 0.
public
opcional integer
Si las estadísticas del enlace son públicas o no, el valor predeterminado es 0.
expiration_url
opcional string
El enlace donde el usuario será redirigido una vez que el enlace haya expirado.
expiration_date
opcional string
La fecha de vencimiento del enlace en: formato YYYY-MM-DD.
expiration_time
opcional string
El tiempo de vencimiento del enlace en: formato HH:MM.
expiration_clicks
opcional integer
El número de clics después de los cuales el enlace debe expirar.
target_type
opcional integer
El tipo de segmentación, los valores posibles son: 0 para Nada, 1 para Geografia, 2 para Plataforma, 3 para Rotación.
geo[index][key]
opcional string
El código del país objetivo. El código debe estar en ISO 3166-1 alpha-2.
geo[index][value]
opcional string
El enlace del país al que se redireccionará 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 de la plataforma donde se redirigirá al usuario.
rotation[index][value]
opcional string
El vínculo de rotación al que se redirigirá al usuario.
Actualizar

Actualiza un enlace.

API Cliente:

PUT PATCH
http://hx2.xyz/api/v1/links/{id}

Ejemplo de requisito:

curl --location --request PUT 'http://hx2.xyz/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 organizar.
alias
opcional string
El alias de enlace.
password
opcional string
La contraseña del enlace.
space
opcional integer
El espacio es el enlace para guardar en.
domain
opcional integer
El dominio es el enlace que se guardará en.
disabled
opcional integer
Si el enlace está deshabilitado o no, el valor predeterminado es 0.
public
opcional integer
Si las estadísticas del enlace son públicas o no, el valor predeterminado es 0.
expiration_url
opcional string
El enlace donde el usuario será redirigido una vez que el enlace haya expirado.
expiration_date
opcional string
La fecha de vencimiento del enlace en: formato YYYY-MM-DD.
expiration_time
opcional string
El tiempo de vencimiento del enlace en: formato HH:MM.
expiration_clicks
opcional integer
El número de clics después de los cuales el enlace debe expirar.
target_type
opcional integer
El tipo de segmentación, los valores posibles son: 0 para Nada, 1 para Geografia, 2 para Plataforma, 3 para Rotación.
geo[index][key]
opcional string
El código del país objetivo. El código debe estar en ISO 3166-1 alpha-2.
geo[index][value]
opcional string
El enlace del país al que se redireccionará 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 de la plataforma donde se redirigirá al usuario.
rotation[index][value]
opcional string
El vínculo de rotación al que se redirigirá al usuario.
Borrar

Borra un enlace.

API Cliente:

DELETE
http://hx2.xyz/api/v1/links/{id}

Ejemplo de requisito:

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