Liens

Notes
Niveau expert
La clé API doit être envoyée en tant que jeton Bearer dans l'en-tête d'autorisation de la demande. Obtenez votre clé API.
Liste

Point de terminaison de l'API:

GET 
https://pixy.link/api/v1/links

Exemple de requête: 

curl --location --request GET 'https://pixy.link/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Paramètre
Type
Description
search
optionnel string
Recherche de requête.
by
optionnel string
Rechercher par. Les valeurs possibles sont: title pour Titre, alias pour Alias, url pour URL. Par défaut à: title.
status
optionnel integer
Filtrer par statut. Les valeurs possibles sont: 0 pour Tout, 1 pour Actif, 2 pour Expiré, 3 pour Désactivé. Par défaut à: 0.
space
optionnel integer
Filtrer par ID d'espace.
domain
optionnel integer
Filtrer par ID de domaine.
pixel
optionnel integer
Filtrer par ID de pixel.
sort
optionnel string
Sorte. Les valeurs possibles sont: desc pour Décroissant, asc pour Croissant, max pour Meilleure performance, min pour Moins bonne performance. Par défaut à: desc.
per_page
optionnel int
Résultats par page. Les valeurs possibles sont: 10 à 100. Par défaut à: 10.
Montrer

Point de terminaison de l'API:

GET 
https://pixy.link/api/v1/links/{id}

Exemple de requête: 

curl --location --request GET 'https://pixy.link/api/v1/links/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Boutique

Point de terminaison de l'API:

POST 
https://pixy.link/api/v1/links

Exemple de requête: 

curl --location --request POST 'https://pixy.link/api/v1/links' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Paramètre
Type
Description
url
requis string
Le lien à raccourcir.
domain
requis integer
L'ID de domaine sous lequel le lien doit être enregistré.
alias
optionnel string
Alias du lien.
password
optionnel string
Le mot de passe du lien.
space
optionnel integer
L'identifiant de l'espace sous lequel le lien doit être enregistré.
pixels
optionnel array
The pixel IDs to be integrated in the link.
disabled
optionnel integer
Que le lien soit désactivé ou non. Les valeurs possibles sont: 0 pour Actif, 1 pour Désactivé. Par défaut à: 0.
privacy
optionnel integer
Que les statistiques du lien soient publiques ou non. Les valeurs possibles sont: 0 pour Public, 1 pour Privé, 2 pour Mot de passe. Par défaut à: 0.
privacy_password
optionnel string
Le mot de passe de la page de statistiques. Fonctionne uniquement avec privacy mis à 2.
expiration_url
optionnel string
Le lien vers lequel l'utilisateur sera redirigé une fois le lien expiré.
expiration_date
optionnel string
La date d'expiration du lien au format YYYY-MM-DD.
expiration_time
optionnel string
Le délai d'expiration du lien au format HH:MM.
expiration_clicks
optionnel integer
Le nombre de clics après lequel le lien doit expirer.
target_type
optionnel integer
Le type de ciblage. Les valeurs possibles sont: 0 pour Rien, 1 pour Géographique, 2 pour Platforme, 4 pour Rotation.
country[index][key]
optionnel string
Le code du pays ciblé. Le code doit être au standart ISO 3166-1 alpha-2.
country[index][value]
optionnel string
Le lien vers lequel l'utilisateur sera redirigé.
platform[index][key]
optionnel string
Le nom de la plateforme ciblée. Les valeurs possibles sont: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
optionnel string
Le lien vers lequel l'utilisateur sera redirigé.
language[index][key]
optionnel string
Le code de la langue ciblée. Le code doit être au standart ISO 639-1 alpha-2.
language[index][value]
optionnel string
Le lien vers lequel l'utilisateur sera redirigé.
rotation[index][value]
optionnel string
Le lien vers lequel l'utilisateur sera redirigé.
Mettre à jour

Point de terminaison de l'API:

PUT PATCH 
https://pixy.link/api/v1/links/{id}

Exemple de requête: 

curl --location --request PUT 'https://pixy.link/api/v1/links/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Paramètre
Type
Description
url
optionnel string
Le lien à raccourcir.
alias
optionnel string
Alias du lien.
password
optionnel string
Le mot de passe du lien.
space
optionnel integer
L'identifiant de l'espace sous lequel le lien doit être enregistré.
pixels
optionnel array
The pixel IDs to be integrated in the link.
disabled
optionnel integer
Que le lien soit désactivé ou non. Les valeurs possibles sont: 0 pour Actif, 1 pour Désactivé.
privacy
optionnel integer
Que les statistiques du lien soient publiques ou non. Les valeurs possibles sont: 0 pour Public, 1 pour Privé, 2 pour Mot de passe.
privacy_password
optionnel string
Le mot de passe de la page de statistiques. Fonctionne uniquement avec privacy mis à 2.
expiration_url
optionnel string
Le lien vers lequel l'utilisateur sera redirigé une fois le lien expiré.
expiration_date
optionnel string
La date d'expiration du lien au format YYYY-MM-DD.
expiration_time
optionnel string
Le délai d'expiration du lien au format HH:MM.
expiration_clicks
optionnel integer
Le nombre de clics après lequel le lien doit expirer.
target_type
optionnel integer
Le type de ciblage. Les valeurs possibles sont: 0 pour Rien, 1 pour Géographique, 2 pour Platforme, 4 pour Rotation.
country[index][key]
optionnel string
Le code du pays ciblé. Le code doit être au standart ISO 3166-1 alpha-2.
country[index][value]
optionnel string
Le lien vers lequel l'utilisateur sera redirigé.
platform[index][key]
optionnel string
Le nom de la plateforme ciblée. Les valeurs possibles sont: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
optionnel string
Le lien vers lequel l'utilisateur sera redirigé.
language[index][key]
optionnel string
Le code de la langue ciblée. Le code doit être au standart ISO 639-1 alpha-2.
language[index][value]
optionnel string
Le lien vers lequel l'utilisateur sera redirigé.
rotation[index][value]
optionnel string
Le lien vers lequel l'utilisateur sera redirigé.
Supprimer

Point de terminaison de l'API:

DELETE 
https://pixy.link/links/{id}/destroy

Exemple de requête: 

curl --location --request DELETE 'https://pixy.link/links/{id}/destroy' \
--header 'Authorization: Bearer {api_key}'