Розробникам

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 годин після відправлення.