Ontwikkelaars

X.gd Developers

We bieden een API voor het verkorten van URL's vanuit externe applicaties. Een API-sleutel is vereist om de API te gebruiken.

URL-verkortings-API

Shorten API v1.0

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

Verzoek

*	Parameter	Type	Format	Description	Example
*	url	String	http(s)://	Te verkorten URL	https://example.com
	shortid	String	[0-9a-zA-Z_]{6,15}	Aangepaste korte URL. Willekeurige toewijzing indien weggelaten	example
	analytics	String	true / false	Toegangsanalyse inschakelen. Ingeschakeld indien weggelaten	true
	filterbots	String	true / false	Botfiltering wanneer analyse is ingeschakeld. Uitgeschakeld indien weggelaten	false
*	key	String	[0-9a-f]{32}	Uitgegeven API-sleutel	0af50e06255c7004f9ad71338f5ad56e

Voorbeeldverzoek (URL)

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

Voorbeeldverzoek (cURL)

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

Antwoord (Succes)

*	Parameter	Type	Format	Description	Example
*	status	Number	200	Statuscode	200
*	shorturl	String	https://x.gd/[0-9a-zA-Z_]+	Verkorte URL	https://x.gd/example
*	analytics	Boolean	true / false	Toegangsanalyse	true
*	filterbots	Boolean	true / false	Botfiltering	false
*	originalurl	String	http(s)://	Oorspronkelijke URL	https://example.com

Voorbeeldantwoord

status: 200
content-type: application/json

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

Antwoord (Mislukt)

*	Parameter	Type	Format	Description	Example
*	status	Number	400 / 401 / 403 / 409 / 429 / 500 / 503	Statuscode	429
*	message	String	-	Foutmelding	Too many requests.

Voorbeeldantwoord

status: 200
content-type: application/json

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

Statuscode

Status	Description
200	Het antwoord is normaal.
400	Er is een fout opgetreden in het verzoek. Het bericht bevat details.
401	Het token is niet geldig. Controleer uw API-sleutel.
403	Tijdelijk of permanent niet beschikbaar.
409	Kan geen verkorte URL uitgeven onder de gevraagde voorwaarden. Het bericht bevat details.
429	API-gebruikslimiet bereikt. Wacht tot de limiet is opgeheven en probeer het opnieuw.
500	Er is een tijdelijke systeemfout opgetreden. Probeer het na enige tijd opnieuw.
503	De service is tijdelijk niet beschikbaar. Probeer het na enige tijd opnieuw.

API-sleutel

We sturen een URL naar het e-mailadres dat u heeft opgegeven om een API-sleutel uit te geven.
U moet de procedure binnen 24 uur na verzending voltooien.