Utvecklare | X.gd

X.gd Developers

Vi tillhandahåller ett API för att förkorta URL:er från externa applikationer. En API-nyckel krävs för att använda API:et.

URL-förkortnings-API

Shorten API v1.0

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

Förfrågan

*	Parameter	Type	Format	Description	Example
*	url	String	http(s)://	URL att förkorta	https://example.com
	shortid	String	[0-9a-zA-Z_]{6,15}	Anpassad kort URL. Slumpmässig tilldelning om utelämnad	example
	analytics	String	true / false	Aktivera åtkomstanalys. Aktiverad om utelämnad	true
	filterbots	String	true / false	Bot-filtrering när analys är aktiverad. Inaktiverad om utelämnad	false
*	key	String	[0-9a-f]{32}	Utfärdad API-nyckel	0af50e06255c7004f9ad71338f5ad56e

Förfrågningsexempel (URL)

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

Förfrågningsexempel (cURL)

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

Svar (Framgång)

*	Parameter	Type	Format	Description	Example
*	status	Number	200	Statuskod	200
*	shorturl	String	https://x.gd/[0-9a-zA-Z_]+	Förkortad URL	https://x.gd/example
*	analytics	Boolean	true / false	Åtkomstanalys	true
*	filterbots	Boolean	true / false	Bot-filtrering	false
*	originalurl	String	http(s)://	Ursprunglig URL	https://example.com

Svarsexempel

status: 200
content-type: application/json

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

Svar (Fel)

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

Svarsexempel

status: 200
content-type: application/json

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

Statuskod

Status	Description
200	Svaret är normalt.
400	Det uppstod ett fel i förfrågan. Meddelandet innehåller detaljer.
401	Token är inte giltig. Kontrollera din API-nyckel.
403	Tillfälligt eller permanent otillgänglig.
409	Kan inte utfärda förkortad URL under de begärda villkoren. Meddelandet innehåller detaljer.
429	API-användningsgräns nådd. Vänta tills gränsen hävs och försök igen.
500	Ett tillfälligt systemfel uppstod. Försök igen efter en stund.
503	Tjänsten är tillfälligt otillgänglig. Försök igen efter en stund.

API-nyckel

Vi skickar en URL för att utfärda en API-nyckel till e-postadressen du angav.
Du måste slutföra proceduren inom 24 timmar efter inskickning.