Перейти до основного вмісту
API GetQR перебуває в бета-версії та доступний для окремих робочих просторів. До загального релізу деталі можуть змінитися.
API GetQR автентифікує кожен запит за 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

Помилки