Разработчици

X.gd Developers

Предоставяме API за съкращаване на URL от външни приложения. Изисква се API ключ за използване на API.

API за съкращаване на URL

Shorten API v1.0

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

Заявка

*	Parameter	Type	Format	Description	Example
*	url	String	http(s)://	URL за съкращаване	https://example.com
	shortid	String	[0-9a-zA-Z_]{6,15}	Персонализиран кратък URL. Случайно присвояване, ако е пропуснато	example
	analytics	String	true / false	Активиране на аналитика за достъп. Активирана, ако е пропусната	true
	filterbots	String	true / false	Филтриране на ботове, когато аналитиката е активирана. Деактивирана, ако е пропусната	false
*	key	String	[0-9a-f]{32}	Издаден API ключ	0af50e06255c7004f9ad71338f5ad56e

Пример за заявка (URL)

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

Пример за заявка (cURL)

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

Отговор (Успех)

*	Parameter	Type	Format	Description	Example
*	status	Number	200	Код на състоянието	200
*	shorturl	String	https://x.gd/[0-9a-zA-Z_]+	Съкратен URL	https://x.gd/example
*	analytics	Boolean	true / false	Аналитика за достъп	true
*	filterbots	Boolean	true / false	Филтриране на ботове	false
*	originalurl	String	http(s)://	Оригинален URL	https://example.com

Пример за отговор

status: 200
content-type: application/json

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

Отговор (Неуспех)

*	Parameter	Type	Format	Description	Example
*	status	Number	400 / 401 / 403 / 409 / 429 / 500 / 503	Код на състоянието	429
*	message	String	-	Съобщение за грешка	Too many requests.

Пример за отговор

status: 200
content-type: application/json

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

Код на състоянието

Status	Description
200	Отговорът е нормален.
400	Възникна грешка в заявката. Съобщението съдържа подробности.
401	Токенът е невалиден. Моля, проверете вашия API ключ.
403	Временно или постоянно недостъпно.
409	Не може да се издаде съкратен URL при заявените условия. Съобщението съдържа подробности.
429	Достигнат е лимитът за използване на API. Изчакайте, докато лимитът бъде премахнат и опитайте отново.
500	Възникна временна системна грешка. Опитайте отново след известно време.
503	Услугата е временно недостъпна. Опитайте отново след известно време.

API ключ

Ще изпратим URL за издаване на API ключ до имейл адреса, който сте въвели.
Трябва да завършите процедурата в рамките на 24 часа след изпращането.