Vývojári | X.gd

X.gd Developers

Poskytujeme API na skracovanie URL z externých aplikácií. Na použitie API je vyžadovaný kľúč API.

API skracovania URL

Shorten API v1.0

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

Požiadavka

*	Parameter	Type	Format	Description	Example
*	url	String	http(s)://	URL na skrátenie	https://example.com
	shortid	String	[0-9a-zA-Z_]{6,15}	Vlastný krátky URL. Náhodné pridelenie, ak je vynechané	example
	analytics	String	true / false	Povoliť analytiku prístupu. Povolené, ak je vynechané	true
	filterbots	String	true / false	Filtrovanie botov, keď je analytika povolená. Zakázané, ak je vynechané	false
*	key	String	[0-9a-f]{32}	Vydaný kľúč API	0af50e06255c7004f9ad71338f5ad56e

Príklad požiadavky (URL)

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

Príklad požiadavky (cURL)

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

Odpoveď (Úspech)

*	Parameter	Type	Format	Description	Example
*	status	Number	200	Stavový kód	200
*	shorturl	String	https://x.gd/[0-9a-zA-Z_]+	Skrátená URL	https://x.gd/example
*	analytics	Boolean	true / false	Analytika prístupu	true
*	filterbots	Boolean	true / false	Filtrovanie botov	false
*	originalurl	String	http(s)://	Pôvodná URL	https://example.com

Príklad odpovede

status: 200
content-type: application/json

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

Odpoveď (Neúspech)

*	Parameter	Type	Format	Description	Example
*	status	Number	400 / 401 / 403 / 409 / 429 / 500 / 503	Stavový kód	429
*	message	String	-	Chybová správa	Too many requests.

Príklad odpovede

status: 200
content-type: application/json

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

Stavový kód

Status	Description
200	Odpoveď je normálna.
400	V požiadavke došlo k chybe. Správa obsahuje podrobnosti.
401	Token je neplatný. Skontrolujte svoj kľúč API.
403	Dočasne alebo trvale nedostupné.
409	Nie je možné vydať skrátenú URL za požadovaných podmienok. Správa obsahuje podrobnosti.
429	Dosiahnutý limit použitia API. Počkajte, kým bude limit uvoľnený a skúste znova zavolať.
500	Dočasne došlo k systémovej chybe. Skúste znova zavolať po určitom čase.
503	Služba je dočasne nedostupná. Skúste znova zavolať po určitom čase.

Kľúč API

Pošleme URL na vydanie kľúča API na e-mailovú adresu, ktorú ste zadali.
Musíte dokončiť postup do 24 hodín od odoslania.