Авторизация

Адрес API

HOST: https://app.helpfy.ai/api/v1

Для собственной установки замените https://app.helpfy.ai на адрес своего сервера.

Авторизация

Передавайте email пользователя и его персональный API-ключ с помощью Basic Authorization. Ключ можно получить в настройках аккаунта Helpfy AI. Полный ключ показывается при создании или перевыпуске — сохраните его сразу.

Параметры авторизации

Параметр	Тип	Обязательный	Описание
email	строка	Да	Email учётной записи Helpfy AI
api_key	строка	Да	Персональный API-ключ этой учётной записи

Пример заголовка

Authorization: Basic dXNlckBleGFtcGxlLmNvbTphcGlfa2V5

Значение после Basic — строка user@example.com:api_key, закодированная в Base64. В запросе используйте свой email и ключ. Передавайте их только по HTTPS.

Пример запроса

URL

https://app.helpfy.ai/api/v1/bots

Заголовки

Заголовок	Значение
Authorization	Basic <base64(email:api_key)>
Accept	application/json

Параметры запроса

Для проверки авторизации параметры не требуются. Параметры списка ботов.

curl --request GET 'https://app.helpfy.ai/api/v1/bots' \
  --user 'user@example.com:api_key' \
  --header 'Accept: application/json'

curl сформирует заголовок Authorization из значений параметра --user. Замените email и API-ключ на свои.

Ответы

Пример успешного ответа — HTTP 200

Сокращённый пример списка; значения условные.

{
  "data": [{"unique_id":"11111111-1111-4111-8111-111111111111","name":"Поддержка"}],
  "meta": {"skip":0,"take":10,"total":1}
}

Права доступа

API возвращает данные в пределах прав учётной записи. Указывайте идентификаторы своих ботов и связанных с ними записей. Авторизация не предоставляет доступ к чужим объектам.

При 401 проверьте email, API-ключ и заголовок Authorization. При 403 проверьте активность аккаунта и доступ к объекту. Ошибки и ограничения.

Формат тела запроса

Для JSON передавайте Content-Type: application/json. При загрузке файла через --form curl самостоятельно добавляет нужный Content-Type и разделитель частей файла.