Перейти к основному содержанию
GetQR API находится в бета-версии и доступен для отдельных рабочих пространств. До общего релиза детали могут измениться.
GetQR API проверяет каждый запрос по API-ключу вашего аккаунта. У каждого пользователя один ключ, и он действует от вашего имени в одном рабочем пространстве.

​
Перед началом

  • Вы владелец рабочего пространства или редактор. Читатели не могут создать или использовать API-ключ.
  • У владельца рабочего пространства активная подписка.

​
Создание API-ключа

1

Откройте настройки аккаунта

Откройте настройки аккаунта и перейдите в раздел API.
2

Создайте ключ

Нажмите Generate API key.
3

Скопируйте ключ

Покажите ключ и скопируйте его. Ключи начинаются с sk_live_.
Показать и скопировать ключ можно в любой момент. В настройках также видно, когда ключ был создан и когда использовался в последний раз.

​
Авторизация запросов

Передавайте ключ как Bearer-токен в заголовке Authorization каждого запроса:
Проверка состояния — единственный эндпоинт, который работает без ключа.

​
Доступ и роли

  • Роли. Создавать и использовать API-ключ могут только владелец рабочего пространства и редакторы. Читателям это недоступно.
  • Рабочее пространство. Каждый ключ относится к одному рабочему пространству, и каждый запрос выполняется в нём. Передавать ID рабочего пространства не нужно.
  • Проверка при каждом запросе. Доступ проверяется при каждом запросе по вашей текущей роли и подписке владельца рабочего пространства. Ваша собственная подписка не учитывается. Если вашу роль сменят на «Читатель» или подписка владельца закончится, запросы будут возвращать 403, пока доступ не восстановят. Новый ключ не нужен.
  • Удаление из пространства. Если вас удалят из рабочего пространства, ваш API-ключ будет удалён. Если вас добавят снова, создайте новый ключ.

​
Перевыпуск ключа

Перевыпустите ключ, если он утёк или к нему получил доступ тот, кому он не предназначен.
Текущий ключ сразу перестаёт работать. Все приложения и интеграции, которые его используют, не будут работать, пока вы не замените в них ключ на новый.
1

Нажмите Regenerate

В настройках аккаунта перейдите в раздел API и нажмите Regenerate.
2

Подтвердите

Нажмите Regenerate key.
3

Обновите приложения

Скопируйте новый ключ и замените им старый везде, где он используется.

​
Безопасность ключа

Обращайтесь с ключом как с паролем: любой, у кого он есть, может создавать, изменять и удалять QR-коды в вашем рабочем пространстве.
  • Храните его в переменной окружения или менеджере секретов, а не в исходном коде.
  • Вызывайте API только со своего сервера. Никогда не размещайте ключ на сайте, в мобильном приложении или там, где пользователи могут его увидеть.
  • Передавайте его только разработчикам, которым он нужен.
  • Перевыпустите его, как только заподозрите утечку.

​
Частые проблемы

Ключ перевыпустили, или вас удалили из рабочего пространства и ключ был удалён. Скопируйте текущий ключ в настройках аккаунта или создайте новый.
Проверьте, что ваша роль — владелец или редактор и что подписка владельца рабочего пространства активна. Ключ снова заработает, как только доступ восстановят.
API находится в бета-версии и ещё не включён для вашего рабочего пространства.
Они видны только владельцу рабочего пространства и редакторам и только в рабочих пространствах, где включён API.

​
Что дальше

Введение в API

Ошибки