Перейти до вмісту

Public API

Створіть API-ключ і оберіть його scopes

Створюйте ключ у тому workspace, з яким він працюватиме, видавайте лише ті scopes, що потрібні інтеграції, і зберігайте його як секрет. Ключ показують один раз — якщо він загубився, відкличте його й випустіть новий, а не шукайте оригінал.

Кроки

  1. Створюйте ключ усередині того workspace, чиїх кодів він торкатиметься. Ключі не переходять між просторами.
  2. Видавайте найвужчі scopes, з якими інтеграція працює, — лише читання, якщо вона лише читає.
  3. Одразу скопіюйте ключ у сховище секретів.
  4. Автентифікуйтеся через Bearer або заголовок X-Mosaqo-API-Key — що зручніше вашому клієнту.
  5. Обмежуйте за адресою, де можете, і робіть ротацію за розкладом.

Як перевірити результат

Викличте identity-ендпоінт, наприклад /me. Він має відповісти тим workspace, який ви очікуєте, — це заразом підтверджує, куди ключ прив’язаний.

Що зазвичай іде не так

  • Ключ, закомічений у репозиторій або вставлений у чат.
  • Один всемогутній ключ на всі інтеграції.
  • Ключ, створений не в тому workspace, який потім на все віддає 403.
Це допомогло завершити задачу?

Це не допомогло

Напишіть нам, вказавши платформу й версію, виконані кроки, очікуваний результат і те, якого workspace чи QR-коду це стосується. Замаскуйте будь-які секрети перед тим, як щось прикріпляти.

Написати в підтримку