Docs HCAPP

Русский

English

Русский

English

Appearance

Log in

Bot API HCAPP ​

Bot API HCAPP - это отдельный API-контур для внешних ботов и AI-агентов.

Он предназначен для создания задач, чтения задач, обновления отдельных полей и загрузки файлов от имени bot-пользователя.

Кто может использовать ​

  • Только пользователь с ролью BOT
  • Только с Authorization: Bearer <token>
  • Токен должен принадлежать пользователю с ролью BOT
  • Бот работает только в рамках доступов к формам, которые есть у этого пользователя
  • Для операций с задачей доступ проверяется по task.form_id

Базовый формат ответа ​

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

json
{
  "success": true,
  "error_message": null,
  "data": {}
}

Ответ с ошибкой:

json
{
  "success": false,
  "error_message": "Form access not found",
  "data": null
}

Эндпойнты ​

  • GET /bot/auth/verify
  • POST /bot/forms/{form_id}/tasks
  • GET /bot/tasks/{task_id}
  • PATCH /bot/tasks/{task_id}/items/{form_field_id}
  • POST /bot/files/upload

Все четыре endpoint сейчас отвечают с payload в обертке success/error_message/data.
Успешное создание задачи возвращает 200, а не 201.

Темы ​