API сокращателя URL для разработчиков

Интегрируйте создание коротких ссылок в ваши приложения и рабочие процессы с помощью нашего REST API. Полная документация включена.

Простой REST API

Создавайте, обновляйте и управляйте короткими ссылками программно. Наш REST API прост и понятен с подробной документацией и примерами кода.

  • RESTful-эндпоинты для CRUD-операций
  • Формат запросов и ответов JSON
  • Подробная документация API

Аутентификация по API-ключу

Аутентифицируйтесь с помощью API-ключей для межсерверной интеграции. Генерируйте и управляйте ключами из панели управления.

  • Генерируйте API-ключи из панели управления
  • Безопасная межсерверная аутентификация
  • Встроенное ограничение скорости запросов

Интеграция собственного домена

Используйте собственный домен для ссылок, созданных через API. Брендирование собственным доменом для единообразного пользовательского опыта.

  • Все ссылки, созданные через API, используют ваш собственный домен
  • Настраивайте домены через панель управления или API
  • Руководства по настройке DNS включены в документацию

Как интегрировать API сокращателя URL

От API-ключа до первой короткой ссылки — за четыре шага.

1

Сгенерируй API-ключ

Перейди в настройки панели управления и создай API-ключ. Это твой Bearer-токен для всех API-запросов.

2

Отправь POST-запрос

Обратись к эндпоинту /api/v1/short-url с длинным URL и опциональным собственным слагом в JSON-теле.

3

Получи короткую ссылку

API возвращает JSON-ответ с коротким URL, временной меткой создания и ID ссылки для дальнейшего использования.

4

Получи аналитику кликов

Используй эндпоинты аналитики для получения количества кликов, временных меток, данных об устройствах и географии по каждой ссылке.

Лучшие практики для разработчиков

Относись к ссылкам как к конфигурации

Держи короткую ссылку стабильной, и пусть меняется именно назначение. В этом весь смысл слоя косвенности.

Генерируй ссылки в CI

С REST API ссылки релиза создаёт твой пайплайн, а не руки перед каждым запуском.

Сужай области действия ключей API

Выпускай отдельный ключ на интеграцию. Ротация одного тогда не означает аудит каждого написанного тобой скрипта.

Разверни у себя, если нужно

Стек под лицензией MIT и открыт. Если правила комплаенса не допускают стороннюю переадресацию, запусти свою.

Часто задаваемые вопросы

Аутентификация Bearer-токеном. Сгенерируй API-ключ в панели управления и добавь его в заголовок Authorization: Authorization: Bearer YOUR_API_KEY.

Начните разработку с нашим API

REST API для коротких ссылок с полной документацией. Интегрируйте сокращение URL в ваши приложения уже сегодня.