Документация API

Интегрируйте сокращение ссылок ly1.ru в ваши приложения с помощью простого REST API.

🔐 Требуется аутентификация

Для доступа к API требуется аутентификация. Войдите через Google, чтобы получить API ключ. Войти

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

Все API запросы требуют аутентификации с помощью API ключа. Добавьте его в заголовок запроса:

Authorization: Bearer YOUR_API_KEY

Или используйте заголовок X-API-Key :

X-API-Key: YOUR_API_KEY

Эндпоинты

POST /api/v1/shorten

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

Параметры запроса

Параметр Тип Описание
url обязательный string URL для сокращения (должен быть валидным HTTP/HTTPS URL)
custom необязательный string Кастомный алиас (3-32 буквенно-цифровых символа)

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

# Using curl
curl -X POST https://ly1.ru/api/v1/shorten \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com/very/long/url", "custom": "mylink"}'
# Using PHP
$ch = curl_init('https://ly1.ru/api/v1/shorten');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_API_KEY',
        'Content-Type: application/json'
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'url' => 'https://example.com/very/long/url',
        'custom' => 'mylink'
    ])
]);
$response = json_decode(curl_exec($ch), true);

Успешный ответ (200)

{
  "success": true,
  "data": {
    "code": "mylink",
    "short_url": "https://ly1.ru/mylink",
    "subdomain_url": "https://mylink.ly1.ru",
    "original_url": "https://example.com/very/long/url"
  }
}

Ответ с ошибкой (400/401)

{
  "success": false,
  "error": "Error message here"
}

Коды ошибок

Code Описание
400 Неверный запрос — Неправильные параметры или URL
401 Не авторизован — Неверный или отсутствующий API ключ
405 Метод не разрешён — Используйте POST
500 Внутренняя ошибка сервера

Лимиты запросов

В настоящее время строгих лимитов нет, но будьте разумны. Чрезмерные запросы могут привести к временной блокировке.