REST API и webhooks уже доступны
Создавайте QR-коды и короткие ссылки из своих систем через API с ключами и областями доступа.
- Ключи с префиксом qrw_live_
- Ограничение 300 запросов в минуту на ключ
- Вебхуки для изменений ссылок
curl -X POST https://app.smartqrcodes.io/api/v1/qr-codes \ -H "Authorization: Bearer qrw_live_YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{ "title": "Autumn menu", "type": "URL", "content": "https://cafe.example/menu", "isDynamic": true, "slug": "autumn" }'→ 201 Created{ "id": "8b1e27d3-2b57-4b6f-b6c4-a9f6cf79ea31", "shortLink": { "slug": "autumn" }, "isActive": true }
API-ключ ограничивается выбранными правами доступа. Полный секрет сохраняют при выпуске.
Доступность функций
Что работает сейчас
Для /api/v1 используются API-ключи qrw_live_… с Bearer-аутентификацией и scopes. Лимит — 300 запросов в минуту на ключ.
Ключи с префиксом qrw_live_
Полный секрет показывается только при создании или ротации ключа. Сохраните его сразу в защищённом хранилище, а если секрет потерян, выполните ротацию.
Ограничение 300 запросов в минуту на ключ
Scopes API-ключа определяют доступные ресурсы и операции. Каждый запрос проверяется отдельно.
Вебхуки для изменений ссылок
Создавайте QR-коды и короткие ссылки из своих систем через API с ключами и областями доступа.
Что доступно через текущий API
Scopes API-ключа определяют доступные ресурсы и операции. Каждый запрос проверяется отдельно.
Аутентификация по scope
Ключ передаётся как Authorization: Bearer qrw_live_… и получает доступ только к разрешённым ресурсам и операциям.
Мини-сайты и проекты
Отдельные read/write scopes позволяют выдать интеграции только нужные права.
Изоляция запросов
Каждый запрос независимо проверяется по API-ключу и его scopes.
Жизненный цикл ключа
Ключ можно создать, настроить, ротировать и отозвать; полный секрет не возвращается в списке ключей.
Граница документации
Справочник маршрутов и примеры запросов есть в личном кабинете; файлы OpenAPI, официального SDK и клиентских библиотек пока не опубликованы.
Секрет ключа показывается один раз
Ротация отзывает предыдущий ключ и выдаёт замену, а отзыв прекращает дальнейшую авторизацию этим ключом.
Bearer-аутентификация по API-ключу
Передавайте ключ с префиксом qrw_live_… в заголовке Authorization: Bearer. Scopes ограничивают доступные операции, а лимит составляет 300 запросов в минуту на ключ.
- Создание, просмотр и настройка API-ключей
- Ротация и отзыв ключей
- Однократный показ полного секрета
- Authorization: Bearer qrw_live_…
Authorization: Bearer qrw_live_YOUR_KEY
Полный секрет показывается только при создании или ротации ключа. Сохраните его сразу в защищённом хранилище, а если секрет потерян, выполните ротацию.
Контракт API-запроса
В таблице собраны обязательные параметры действующего внешнего API.
| Контракт API-запроса | Требование | Текущий API |
|---|---|---|
| Аутентификация | API-ключ | Bearer qrw_live_… |
| Заголовок | Authorization | Bearer qrw_live_… |
| Контроль доступа | Scopes API-ключа | Проверяются в каждом запросе |
| Лимит запросов | На один API-ключ | 300 запросов в минуту |
- Аутентификация
- Требование
- API-ключ
- Текущий API
- Bearer qrw_live_…
- Заголовок
- Требование
- Authorization
- Текущий API
- Bearer qrw_live_…
- Контроль доступа
- Требование
- Scopes API-ключа
- Текущий API
- Проверяются в каждом запросе
- Лимит запросов
- Требование
- На один API-ключ
- Текущий API
- 300 запросов в минуту
Быстрый старт
Как подключить серверную интеграцию
Создайте ключ с минимальными правами, сохраните показанный один раз секрет и передавайте его только из доверенного окружения.
- 1
Создайте ключ
Получите ключ для серверной интеграции, задайте минимальные необходимые scopes и сохраните секрет в защищённом хранилище.
- 2
Выберите scopes
Оставьте только права чтения и записи, которые действительно нужны интеграции.
- 3
Сохраните секрет
Скопируйте секрет сразу: повторно он не показывается. При утрате выполните ротацию.
- 4
Передайте заголовок
Используйте Authorization: Bearer qrw_live_… на поддерживаемом маршруте /api/v1.
FAQ
Частые вопросы
Как выглядит API-ключ?
Ключ начинается с qrw_live_…. Храните полный секрет только в защищённом серверном окружении и не передавайте его в клиентский код.
Как передавать API-ключ?
Передавайте ключ в заголовке Authorization как Bearer credential или в заголовке X-API-Key. Доступ ограничивается scopes ключа.
Какой лимит запросов действует?
Для каждого API-ключа действует лимит 300 запросов в минуту.
Какие события отправляют webhooks?
Webhooks отправляются для событий создания, изменения и удаления короткой ссылки: link.created, link.updated и link.deleted.
Создайте ключ для серверной интеграции
Выберите минимальные scopes, сохраните секрет при выпуске и используйте его только в доверенном окружении.