Vývojáři

X.gd Developers

Poskytujeme API pro zkracování URL z externích aplikací. Pro použití API je vyžadován klíč API.

API zkracování URL

Shorten API v1.0

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

Požadavek

*	Parameter	Type	Format	Description	Example
*	url	String	http(s)://	URL ke zkrácení	https://example.com
	shortid	String	[0-9a-zA-Z_]{6,15}	Vlastní krátká URL. Náhodné přiřazení, pokud je vynecháno	example
	analytics	String	true / false	Povolit analytiku přístupu. Povoleno, pokud je vynecháno	true
	filterbots	String	true / false	Filtrování botů, když je analytika povolena. Zakázáno, pokud je vynecháno	false
*	key	String	[0-9a-f]{32}	Vydaný klíč API	0af50e06255c7004f9ad71338f5ad56e

Příklad požadavku (URL)

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

Příklad požadavku (cURL)

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

Odpověď (Úspěch)

*	Parameter	Type	Format	Description	Example
*	status	Number	200	Stavový kód	200
*	shorturl	String	https://x.gd/[0-9a-zA-Z_]+	Zkrácená URL	https://x.gd/example
*	analytics	Boolean	true / false	Analytika přístupu	true
*	filterbots	Boolean	true / false	Filtrování botů	false
*	originalurl	String	http(s)://	Původní URL	https://example.com

Příklad odpovědi

status: 200
content-type: application/json

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

Odpověď (Nezdařilo se)

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

Příklad odpovědi

status: 200
content-type: application/json

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

Stavový kód

Status	Description
200	Odpověď je normální.
400	V požadavku došlo k chybě. Zpráva obsahuje podrobnosti.
401	Token je neplatný. Zkontrolujte svůj klíč API.
403	Dočasně nebo trvale nedostupné.
409	Nelze vydat zkrácenou URL za požadovaných podmínek. Zpráva obsahuje podrobnosti.
429	Dosažen limit použití API. Počkejte, až bude limit uvolněn a zkuste znova zavolat.
500	Dočasně došlo k systémové chybě. Zkuste znova zavolat po určité době.
503	Služba je dočasně nedostupná. Zkuste znova zavolat po určité době.

Klíč API

Odešleme URL pro vydání klíče API na e-mailovou adresu, kterou jste zadali.
Musíte dokončit postup do 24 hodin od odeslání.