API, совместимый с YOURLS

Используйте S.EE с любым клиентом или интеграцией, совместимыми с YOURLS

S.EE предоставляет API-эндпоинт, совместимый с YOURLS, что позволяет использовать S.EE с существующими сторонними клиентами и интеграциями, поддерживающими API YOURLS.

Этот эндпоинт создан для упрощения миграции с YOURLS и интеграции S.EE в инструменты автоматизации, расширения браузера и приложения, которые уже используют протокол API YOURLS.

API-эндпоинт

https://s.ee/api/v1/yourls

Область совместимости

Этот эндпоинт реализует частичную совместимость с API YOURLS.

Поддерживается

action=shorturl
Аутентификация signature
Форматы вывода: json, jsonp, xml, simple
GET- и POST-запросы

Не поддерживается

Аутентификация username / password
Другие действия YOURLS, например expand, stats или db-stats
Административные операции и операции, связанные с базой данных

Доступна только функция сокращения URL.

Аутентификация

Поддерживается только аутентификация signature. Аутентификация по имени пользователя / паролю недоступна.

Параметр signature соответствует вашему API-ключ令牌 S.EE.

Создать и управлять API-ключ令牌 можно здесь:

https://s.ee/user/developers/

API-ключ令牌 привязан к авторизованному пользователю и наследует те же права и ограничения, что и аккаунт.

Поддерживаемые действия

Сейчас поддерживается только следующее действие:

Действие	Описание
`shorturl`	Создание короткой ссылки для указанного URL

Параметры

Параметр	Обязателен	Описание
`signature`	Да	Ваш API-ключ令牌 S.EE
`action`	Да	Выполняемое действие (сейчас только `shorturl`)
`url`	Да	URL, который нужно сократить
`format`	Нет	Формат вывода: `json`, `jsonp`, `xml` или `simple` (по умолчанию: `simple`)
`keyword`	Нет	Пользовательский короткий код для короткой ссылки
`title`	Нет	Заголовок короткой ссылки

Примечания

Если указанный keyword уже занят, API автоматически генерирует новый доступный keyword, а не возвращает ошибку.
Ко всем запросам применяются стандартные правила валидации и защиты от злоупотреблений S.EE.

Примеры

POST-запрос

curl -X POST \
  'https://s.ee/api/v1/yourls' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'signature=your_api_token' \
  --data-urlencode 'format=json' \
  --data-urlencode 'action=shorturl' \
  --data-urlencode 'url=https://example.com/'

Ответ:

{
  "status": "success",
  "code": "",
  "message": "https://example.com/ added to database",
  "errorCode": "",
  "statusCode": "200",
  "url": {
    "keyword": "link",
    "url": "https://example.com/",
    "title": "",
    "date": "2026-01-14 21:38:10",
    "ip": "192.0.2.2"
  },
  "shorturl": "https://s.ee/link"
}

Некоторые поля ответа сохранены для совместимости с YOURLS и могут быть пустыми.

GET-запрос

curl -X GET "https://s.ee/api/v1/yourls?action=shorturl&format=simple&signature=your_api_token&url=https://example.com/"

Ответ:

https://s.ee/link

Не забывайте URL-кодировать параметры при использовании GET-запросов.
Для длинных URL или дополнительных параметров рекомендуется использовать POST-запросы, чтобы избежать ограничений на длину URL.

Сторонние клиенты

Этот API совместим с любым клиентом, который поддерживает сокращение URL в стиле YOURLS, включая:

Расширения браузера
Мобильные приложения
Десктопные приложения
Инструменты автоматизации, такие как Shortcuts, Tasker и Zapier

Полное описание исходной спецификации YOURLS API смотрите в официальной документации:

https://yourls.org/readme.html#API

API, совместимый с YOURLS

На этой странице