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

Аутентификация

Все запросы к API авторизуются по токену доступа (bearer-токен). Токен создаётся в настройках аккаунта Coverse и передаётся в каждом запросе.

Как получить токен

Настройки аккаунта → раздел «Автоматизация и API» → создайте токен и выберите права (scopes). Токен показывается один раз при создании — сразу сохраните его в надёжном месте.

Настройки аккаунта → «Автоматизация и API» → «Создать ключ (API-токен)»

Как передавать токен

В заголовке Authorization:

Authorization: Bearer ВАШ_ТОКЕН
curl "https://app.coverse.team/v1/documents?type=table" \
-H "Authorization: Bearer $TOKEN"

Права (scopes)

У каждого токена есть набор прав. Эндпоинт требует конкретное право; если его нет — вернётся 403.

ПравоЧто разрешает
sheets.readчитать документы и значения ячеек
sheets.writeзаписывать значения, работать с листами
sheets.webhooksсоздавать и удалять вебхуки
sheets.crossbook.readчтение между книгами
sheets.agent.writeзапись от имени агента

Выдавайте токену только те права, которые нужны интеграции — это снижает риск при утечке.

Границы доступа

Токен не даёт больше прав, чем есть у пользователя, который его создал. Доступ к конкретному документу проверяется по тем же правилам, что и в приложении: если у пользователя нет доступа к таблице — токен тоже её не увидит.

Безопасное хранение

  • Храните токен в переменных окружения или в защищённом хранилище секретов, а не в коде и не в репозитории.
  • Не передавайте токен на сторону браузера/клиента — только на своём сервере.
  • Если токен скомпрометирован — отзовите его в настройках и создайте новый.
  • Для разных интеграций заводите разные токены — так проще отозвать один, не ломая остальные.

Отозвать токен можно в списке ключей кнопкой «Отозвать»:

Список ключей → «Отозвать»

Ошибки авторизации

  • 401 — токен отсутствует или недействителен.
  • 403 — у токена нет нужного права, либо действие не разрешено тарифом.

Полный список кодов ошибок — в Справочнике API.