Разработчикам

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 часов после отправки.