Перейти к содержимому

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-кода это касается. Замаскируйте любые секреты перед тем, как что-то прикреплять.

Написать в поддержку