Перейти до основного вмісту
API-ключі — це довготривалі посвідчення, які не потребують ротації. Ідеально підходять для серверних інтеграцій, скриптів тощо, адже спрощують взаємодію з API та не вимагають складної логіки оновлення.
Ніколи не використовуйте API-ключі в коді на стороні клієнта (наприклад, у браузері), адже їх легко вкрасти.

​
Застосування

Щоб автентифікувати HTTP-запит за допомогою API-ключа, додайте заголовок X-Api-Key. 
curl --request GET \
  --url '/records' \
  --header 'X-Api-Key: <YOUR_API_KEY>'

​
Обмеження

Кожен API-ключ має два основні параметри, які визначають рівень його доступу до робочого простору.
​
userType
string
за замовчуванням:"user"
обов'язково
Рівень адміністративних повноважень ключа.Можливі значення:
  • user — жодних адміністративних повноважень (рекомендовано для більшості сценаріїв).
  • administrator — можливість керування (включно з повним видаленням) дашбордами, наборами даних, ролями й користувачами (окрім тих, які мають повний адміністративний доступ).
  • owner — можливість керування (включно з повним видаленням) дашбордами, наборами даних, ролями, користувачами (без обмежень) і самим робочим простором.
​
role
integer
за замовчуванням:"null"
Рівень доступу до даних ключа. За замовчуванням — без обмежень.Як і будь-яка роль, визначає, які набори даних будуть доступні (окремо по кожному стану й кожній властивості) та за яких умов.
Оскільки API-ключ не пов’язаний із конкретним користувачем, усі дозволи з умовою «лише якщо призначений» для вказаної ролі не діятимуть.
Ніколи не надавайте вищий рівень доступу до даних, ніж мінімально необхідний. Наприклад, якщо API-ключ надається розробникам вебсайту лише для автоматичного створення заявок при заповненні форми, він не повинен дозволяти отримувати будь-які наявні дані.
Ви можете мати декілька API-ключів для програмної взаємодії з вашим робочим простором — кожен із власним набором обмежень.

​
Отримання ключа

Для отримання API-ключа, будь ласка, зверніться до підтримки Tracy.
API-ключі надаються лише для робочих просторів на тарифному плані «Маленький» і вище.