Fejlesztők

X.gd Developers

API-t biztosítunk külső alkalmazásokból történő URL rövidítéshez. Az API használatához API kulcs szükséges.

URL rövidítő API

Shorten API v1.0

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

Kérés

*	Parameter	Type	Format	Description	Example
*	url	String	http(s)://	Rövidítendő URL	https://example.com
	shortid	String	[0-9a-zA-Z_]{6,15}	Egyéni rövid URL. Véletlenszerű hozzárendelés, ha kihagyva	example
	analytics	String	true / false	Hozzáférési analitika engedélyezése. Engedélyezett, ha kihagyva	true
	filterbots	String	true / false	Bot szűrés, amikor az analitika engedélyezett. Letiltva, ha kihagyva	false
*	key	String	[0-9a-f]{32}	Kiadott API kulcs	0af50e06255c7004f9ad71338f5ad56e

Kérés példa (URL)

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

Kérés példa (cURL)

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

Válasz (Sikeres)

*	Parameter	Type	Format	Description	Example
*	status	Number	200	Állapotkód	200
*	shorturl	String	https://x.gd/[0-9a-zA-Z_]+	Rövidített URL	https://x.gd/example
*	analytics	Boolean	true / false	Hozzáférési analitika	true
*	filterbots	Boolean	true / false	Bot szűrés	false
*	originalurl	String	http(s)://	Eredeti URL	https://example.com

Válasz példa

status: 200
content-type: application/json

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

Válasz (Sikertelen)

*	Parameter	Type	Format	Description	Example
*	status	Number	400 / 401 / 403 / 409 / 429 / 500 / 503	Állapotkód	429
*	message	String	-	Hibaüzenet	Too many requests.

Válasz példa

status: 200
content-type: application/json

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

Állapotkód

Status	Description
200	A válasz normális.
400	Hiba történt a kérésben. Az üzenet tartalmazza a részleteket.
401	A token érvénytelen. Ellenőrizze az API kulcsát.
403	Ideiglenesen vagy véglegesen nem elérhető.
409	Nem lehet rövidített URL-t kiadni a kért feltételek mellett. Az üzenet tartalmazza a részleteket.
429	Elérte az API használati korlátot. Várja meg, amíg a korlát feloldódik, és próbálja újra.
500	Ideiglenesen rendszerhiba történt. Próbálja újra egy idő után.
503	A szolgáltatás ideiglenesen nem elérhető. Próbálja újra egy idő után.

API kulcs

Az API kulcs kiadására szolgáló URL-t elküldjük a megadott e-mail címre.
A folyamatot 24 órán belül be kell fejeznie a küldéstől számítva.