Liens

Notes
Niveau expert
La clé API doit être envoyée en tant que jeton porteur dans l’en-tête Authorization de la demande. Obtenir votre clé API.
Liste

Point de terminaison d’API:

GET 
https://go.qwiper.com/api/v1/links

Exemple de demande: 

curl --location --request GET 'https://go.qwiper.com/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Paramètre
Type
Description :
search
optionnel string
Requête de recherche.
search_by
optionnel string
Recherche par. Les valeurs possibles sont : title pour Titre, alias pour Alias, url pour URL. La valeur par défaut est : title.
status
optionnel integer
Filtrer par état. Les valeurs possibles sont : 0 pour Tout, 1 pour Activé, 2 pour Expiré, 3 pour Désactivé. La valeur par défaut est : 0.
space_id
optionnel integer
Filtrer par ID d’espace.
domain_id
optionnel integer
Filtrer par ID de domaine.
pixel_id
optionnel integer
Filtrer par ID de pixel.
sort_by
optionnel string
Trier par. Les valeurs possibles sont : id pour Date de création, clicks pour Clics, title pour Titre, alias pour Alias, url pour URL. La valeur par défaut est : id.
sort
optionnel string
Trier. Les valeurs possibles sont : desc pour Descendant, asc pour Ascendant. La valeur par défaut est : desc.
per_page
optionnel int
Résultats par page. Les valeurs possibles sont : 10, 25, 50, 100. La valeur par défaut est : 10.
Montrer

Point de terminaison d’API:

GET 
https://go.qwiper.com/api/v1/links/{id}

Exemple de demande: 

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

Point de terminaison d’API:

POST 
https://go.qwiper.com/api/v1/links

Exemple de demande: 

curl --location --request POST 'https://go.qwiper.com/api/v1/links' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}' \
--data-urlencode 'domain={id}'
Paramètre
Type
Description :
url
obligatoire string
Lien à raccourcir.
domain_id
obligatoire integer
ID de domaine sous lequel le lien à enregistrer.
alias
optionnel string
Alias de lien.
password
optionnel string
Mot de passe du lien.
space_id
optionnel integer
ID d’espace sous lequel le lien à enregistrer.
pixel_ids
optionnel array
The pixel IDs to be integrated in the link.
disabled
optionnel integer
Si le lien est désactivé ou non. Les valeurs possibles sont : 0 pour Activé, 1 pour Désactivé. La valeur par défaut est : 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. La valeur par défaut est : 0.
privacy_password
optionnel string
Mot de passe de la page de statistiques. Fonctionne uniquement avec privacy défini sur 2.
expiration_url
optionnel string
Lien où l’utilisateur sera redirigé une fois le lien expiré.
expiration_date
optionnel string
Date d’expiration du lien au format YYYY-MM-DD.
expiration_time
optionnel string
Délai d’expiration du lien au format HH:MM.
expiration_clicks
optionnel integer
Nombre de clics après lequel le lien doit expirer.
target_type
optionnel integer
Type de ciblage. Les valeurs possibles sont : 0 pour Aucun, 1 pour Géographique, 2 pour Appareil, 4 pour Rotation.
country[index][key]
optionnel string
Le code du pays ciblé. Le code doit être en ISO 3166-1 alpha-2 standard.
country[index][value]
optionnel string
Lien vers lequel l’utilisateur sera redirigé.
platform[index][key]
optionnel string
Nom de la plateforme ciblée. Les valeurs possibles sont : iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
optionnel string
Lien vers lequel l’utilisateur sera redirigé.
language[index][key]
optionnel string
Code de la langue ciblée. Le code doit être en ISO 639-1 alpha-2 standard.
language[index][value]
optionnel string
Lien vers lequel l’utilisateur sera redirigé.
rotation[index][value]
optionnel string
Lien vers lequel l’utilisateur sera redirigé.
Mettre à jour

Point de terminaison d’API:

PUT PATCH 
https://go.qwiper.com/api/v1/links/{id}

Exemple de demande: 

curl --location --request PUT 'https://go.qwiper.com/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
Lien à raccourcir.
alias
optionnel string
Alias de lien.
password
optionnel string
Mot de passe du lien.
space_id
optionnel integer
ID d’espace sous lequel le lien à enregistrer.
pixel_ids
optionnel array
The pixel IDs to be integrated in the link.
disabled
optionnel integer
Si le lien est désactivé ou non. Les valeurs possibles sont : 0 pour Activé, 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
Mot de passe de la page de statistiques. Fonctionne uniquement avec privacy défini sur 2.
expiration_url
optionnel string
Lien où l’utilisateur sera redirigé une fois le lien expiré.
expiration_date
optionnel string
Date d’expiration du lien au format YYYY-MM-DD.
expiration_time
optionnel string
Délai d’expiration du lien au format HH:MM.
expiration_clicks
optionnel integer
Nombre de clics après lequel le lien doit expirer.
target_type
optionnel integer
Type de ciblage. Les valeurs possibles sont : 0 pour Aucun, 1 pour Géographique, 2 pour Appareil, 4 pour Rotation.
country[index][key]
optionnel string
Le code du pays ciblé. Le code doit être en ISO 3166-1 alpha-2 standard.
country[index][value]
optionnel string
Lien vers lequel l’utilisateur sera redirigé.
platform[index][key]
optionnel string
Nom de la plateforme ciblée. Les valeurs possibles sont : iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
optionnel string
Lien vers lequel l’utilisateur sera redirigé.
language[index][key]
optionnel string
Code de la langue ciblée. Le code doit être en ISO 639-1 alpha-2 standard.
language[index][value]
optionnel string
Lien vers lequel l’utilisateur sera redirigé.
rotation[index][value]
optionnel string
Lien vers lequel l’utilisateur sera redirigé.
Supprimer

Point de terminaison d’API:

DELETE 
https://go.qwiper.com/api/v1/links/{id}

Exemple de demande: 

curl --location --request DELETE 'https://go.qwiper.com/api/v1/links/{id}' \
--header 'Authorization: Bearer {api_key}'