Udviklere | X.gd

X.gd Developers

Vi leverer en API til URL-forkortelse fra eksterne applikationer. En API-nøgle er påkrævet for at bruge API'en.

URL-forkortelses-API

Shorten API v1.0

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

Anmodning

*	Parameter	Type	Format	Description	Example
*	url	String	http(s)://	URL til forkortelse	https://example.com
	shortid	String	[0-9a-zA-Z_]{6,15}	Brugerdefineret kort URL. Tilfældig tildeling hvis udeladt	example
	analytics	String	true / false	Aktiver adgangsanalyser. Aktiveret hvis udeladt	true
	filterbots	String	true / false	Botfiltrering når analyser er aktiveret. Deaktiveret hvis udeladt	false
*	key	String	[0-9a-f]{32}	Udstedt API-nøgle	0af50e06255c7004f9ad71338f5ad56e

Anmodningseksempel (URL)

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

Anmodningseksempel (cURL)

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

Svar (Succes)

*	Parameter	Type	Format	Description	Example
*	status	Number	200	Statuskode	200
*	shorturl	String	https://x.gd/[0-9a-zA-Z_]+	Forkortet URL	https://x.gd/example
*	analytics	Boolean	true / false	Adgangsanalyser	true
*	filterbots	Boolean	true / false	Botfiltrering	false
*	originalurl	String	http(s)://	Oprindelig URL	https://example.com

Svareksempel

status: 200
content-type: application/json

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

Svar (Fejlet)

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

Svareksempel

status: 200
content-type: application/json

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

Statuskode

Status	Description
200	Svaret er normalt.
400	Der opstod en fejl i anmodningen. Meddelelsen indeholder detaljer.
401	Token er ugyldig. Tjek venligst din API-nøgle.
403	Midlertidigt eller permanent utilgængelig.
409	Kan ikke udstede en forkortet URL under de anmodede betingelser. Meddelelsen indeholder detaljer.
429	API-brugsgrænse nået. Vent indtil grænsen er ophævet og prøv at kalde igen.
500	En systemfejl er opstået midlertidigt. Prøv at kalde igen efter en vis tid.
503	Tjenesten er midlertidigt utilgængelig. Prøv at kalde igen efter en vis tid.

API-nøgle

Vi sender en URL til udstedelse af en API-nøgle til den e-mailadresse, du indtastede.
Du skal fuldføre proceduren inden for 24 timer efter afsendelse.