Domaines disponibles

Renvoie la liste des domaines courts disponibles pour votre compte. Ce sont les valeurs de cette liste qui vont dans le paramètre url_type lorsque vous raccourcissez un lien.

API URL

URL utilisée pour envoyer les requêtes HTTP :

https://portal.bulkgate.com/api/1.0/shortener/domains

Note

Si la requête n'atteint pas sa destination, renvoyez-la sur le serveur de secours backup1.bulkgate.com.

Méthodes HTTP prises en charge

POST - application/json

POST /api/1.0/shortener/domains HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json

Note

L'API est soumise à un quota de 20 requêtes par minute.

Tableau des paramètres

NOM DU PARAMÈTRE	VALEUR	OBLIGATOIRE	VALEUR PAR DÉFAUT
application_id	Application ID	Oui	-
application_token	Jeton d'authentification de l'application	Oui	-
variant	Forme de la réponse - `list`, `key_value` ou `label_value`, voir Formes de réponse	Non	`list`

Formes de réponse

Les trois variantes contiennent les mêmes domaines et ne diffèrent que par leur structure - choisissez celle que votre formulaire peut utiliser directement.

VALEUR	FORME DE `data`
`list`	Un tableau de chaînes.
`key_value`	Un objet dont la clé et la valeur sont toutes deux le domaine.
`label_value`	Un tableau d'objets `{"label": …, "value": …}`.

Note

La liste n'est pas la même pour tous les comptes. Elle contient aussi vos propres domaines, si vous en avez, et ceux-ci figurent en tête - le premier domaine de la liste est aussi celui que shorten utilise lorsque vous omettez url_type.

Exemple de requête

POST /api/1.0/shortener/domains HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "variant": "list" }

Réponse

En cas de succès :

{ "data": [ "ur7.wf", "ms6.fr", "ur7.yt", "ur7.tf", "ms6.wf", "ms6.tf", "track-message.com" ] }

La même liste dans la variante key_value :

{ "data": { "ur7.wf": "ur7.wf", "ms6.fr": "ms6.fr" } }

Et dans la variante label_value :

{ "data": [ {"label": "ur7.wf", "value": "ur7.wf"}, {"label": "ms6.fr", "value": "ms6.fr"} ] }

En cas d'erreur :

{ "type": "the_per_minute_quota_has_been_exceeded", "code": 400, "error": "The per minute quota has been exceeded", "detail": null }

Où :

type et error (description de l'erreur) figurent dans le tableau des types d'erreurs
code est le code d'erreur HTTP
detail est une information complémentaire sur l'erreur

Types d'erreurs de l'API Shortener

Outre les types généraux, cet endpoint renvoie ses propres types :

TYPE	QUAND CELA SE PRODUIT
`the_per_minute_quota_has_been_exceeded`	Le quota de 20 requêtes par minute est épuisé.

Cette page vous a-t-elle été utile ?

Demander à l'IA Copié