Skip to content

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

Схема

Bot API использует только bearer token:

http
Authorization: Bearer <token>

Проверка token

Endpoint:

GET /bot/auth/verify

Это простой utility endpoint для проверки bot token.

Он полезен чтобы:

  • быстро проверить, что token еще жив
  • проверить, что bot auth настроен правильно
  • не делать для этого тестовый create/read
  • использовать endpoint в onboarding и health checks

Пример curl:

bash
curl -X GET \
  -H "Authorization: Bearer <token>" \
  https://public-api.hcapp.ee/bot/auth/verify

Успешный ответ:

json
{
  "success": true,
  "error_message": null,
  "data": {
    "user_id": 38,
    "company_id": 3,
    "role": "BOT"
  }
}

Если token невалиден или истек, API возвращает 401.

Требования к токену

  • Используйте bot token, выданный системой HCAPP
  • Token передается в заголовке Authorization: Bearer <token>
  • Token имеет срок действия
  • Token привязан к пользователю с ролью BOT

Если токен принадлежит не bot-пользователю, API возвращает:

json
{
  "success": false,
  "error_message": "Bot token required",
  "data": null
}

с HTTP status 403.

Что важно по доступам

  • Сам факт валидного bot token не дает доступ ко всем формам
  • При создании задачи бот должен иметь access к целевой форме
  • При чтении и апдейте проверка идет через task.form_id

Что не делает bot API

В текущем коде bot API нет отдельного endpoint для выдачи токена.
В этом разделе описано использование уже выданного bot token.