SHORT · API v1

Ваши ссылки. Ваш API.

Базовый URL: https://api.short.romanich237.dev/api/v1

Токен из профиля

Войдите на сайт, откройте Профиль → API → Создать токен. Токен показывается один раз и действует семь дней. Формат: cyxaptop_ + 64 случайных hex-символа. В профиле можно создать до десяти активных токенов и отозвать любой из них.

Перейти на сайт ↗

Регистрация и получение токенов через публичные запросы email/пароля отключены. Запросы к ссылкам требуют Authorization: Bearer <token>.

cURL · терминал

Актуальные домены

Получите список доменов из текущей конфигурации сервиса. Метод требует API-токен.

GET /domains

curl https://api.short.romanich237.dev/api/v1/domains \
  -H 'Authorization: Bearer cyxaptop_YOUR_TOKEN'

{
  "domains": ["short.romanich237.dev", "cyxap.top", "gaming-bot.online", "kucumber.online"],
  "defaultDomain": "short.romanich237.dev"
}

Пример списка: сервер может вернуть дополнительные настроенные домены. Передавайте выбранный домен из domains в поле domain при создании ссылки.

Создать ссылку

POST /links

curl -X POST https://api.short.romanich237.dev/api/v1/links \
  -H 'Authorization: Bearer cyxaptop_YOUR_RANDOM_STRING' \
  -H 'Content-Type: application/json' \
  -d '{"url":"https://example.com","domain":"cyxap.top","acceptedRules":true}'

Необязательное поле code — от 3 до 32 латинских букв, цифр, дефисов или подчёркиваний. Домены: cyxap.top, gaming-bot.online, kucumber.online, short.romanich237.dev. Допустимы http и https.

{"link":{"id":1,"code":"hello","destination":"https://example.com/","clicks":0,"shortUrl":"https://cyxap.top/hello"}}

Методы

Метод	Путь	Назначение
GET	/auth/session	Проверить токен
POST	/auth/logout	Отозвать токен
GET	/domains	Актуальные домены и домен по умолчанию
GET	/links	Свои ссылки, до 250, с moderation_status
GET	/links/:code	Получить свою ссылку
POST	/links	Создать ссылку
PATCH	/links/:code	Изменить url и необязательный code
DELETE	/links/:code	Удалить свою активную ссылку

Другие запросы

Выберите метод. Примеры используют тот же язык, что и переключатель выше. Замените токен и код hello своими значениями. Ответ выводится вместе с HTTP-статусом, в том числе при ошибках и пустом ответе 204.

Запрос

Пример запроса

Для просмотра примеров включите JavaScript в браузере.

Ошибки модерации

При получении, изменении или удалении ссылки API возвращает одно сообщение, если её заблокировал или удалил администратор. Список /links сохраняет эти записи со статусами blocked и deleted.

HTTP 410
{"error":"Ссылка удалена администратором."}

Чужая ссылка возвращает 404. Другие ошибки: 400 — некорректные данные; 401 — недействительный токен; 409 — код занят; 429 — слишком много запросов. Публичные /auth/login и /auth/register возвращают 403 API_PROFILE_REQUIRED. Успешное удаление и отзыв токена — 204 без тела.