Développeurs

X.gd Developers

Nous fournissons une API pour raccourcir les URL depuis des applications externes. Une clé API est requise pour utiliser l'API.

API de raccourcissement d'URL

Shorten API v1.0

GET https://xgd.io/V1/shorten

Requête

*	Parameter	Type	Format	Description	Example
*	url	String	http(s)://	URL à raccourcir	https://example.com
	shortid	String	[0-9a-zA-Z_]{6,15}	URL courte personnalisée. Attribution aléatoire si omis	example
	analytics	String	true / false	Activer les analyses d'accès. Activé si omis	true
	filterbots	String	true / false	Filtrage des bots lorsque les analyses sont activées. Désactivé si omis	false
*	key	String	[0-9a-f]{32}	Clé API émise	0af50e06255c7004f9ad71338f5ad56e

Exemple de requête (URL)

https://xgd.io/V1/shorten?url=https://example.com&key={Your API Key}

Exemple de requête (cURL)

curl -X GET 'https://xgd.io/V1/shorten?url=https://example.com&key={Your API Key}'

Réponse (Succès)

*	Parameter	Type	Format	Description	Example
*	status	Number	200	Code de statut	200
*	shorturl	String	https://x.gd/[0-9a-zA-Z_]+	URL raccourcie	https://x.gd/example
*	analytics	Boolean	true / false	Analyses d'accès	true
*	filterbots	Boolean	true / false	Filtrage des bots	false
*	originalurl	String	http(s)://	URL originale	https://example.com

Exemple de réponse

status: 200
content-type: application/json

{
    "status": 200,
    "shorturl": "https://x.gd/example",
    "analytics": true,
    "filterbots": false,
    "originalurl": "https://example.com/"
}

Réponse (Échec)

*	Parameter	Type	Format	Description	Example
*	status	Number	400 / 401 / 403 / 409 / 429 / 500 / 503	Code de statut	429
*	message	String	-	Message d'erreur	Too many requests.

Exemple de réponse

status: 200
content-type: application/json

{
    "status": 429,
    "message": "Too many requests."
}

Code de statut

Status	Description
200	La réponse est normale.
400	Une erreur s'est produite dans la requête. Le message contient les détails.
401	Le jeton n'est pas valide. Vérifiez votre clé API.
403	Temporairement ou définitivement indisponible.
409	Impossible d'émettre une URL raccourcie dans les conditions demandées. Le message contient les détails.
429	Limite d'utilisation de l'API atteinte. Attendez que la limite soit levée et réessayez.
500	Une erreur système temporaire s'est produite. Réessayez après un certain temps.
503	Le service est temporairement indisponible. Réessayez après un certain temps.

Clé API

Nous enverrons une URL pour émettre une clé API à l'adresse e-mail que vous avez fournie.
Vous devez compléter la procédure dans les 24 heures suivant l'envoi.