Перейти к содержанию

Введение

Важно

Перед началом работы необходимо подключить интеграцию с бизнес-чатом. Для этого обратитесь к менеджеру компании или в техническую поддержку.

Для отправки запросов в API бизнес-чата необходима авторизация.

Бизнес-чат поддерживает только базовый тип авторизации - комбинацию логина и пароля учётной записи Business Chat в кодировке Base64.

Создание заголовка аутентификации

  • Строки login и password объединяются с использованием двоеточия (:) в качестве разделителя (login:password).
  • Результирующая строка кодируется с использованием Base64.
  • Закодированная строка добавляется в заголовок после указания типа авторизации (Basic).
Authorization: Basic bG9naW46cGFzc3dvcmQ=

Метод авторизации

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

Для этого необходимо вызвать POST /api​/sign-in, передавая данные авторизации в заголовке.

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

curl -X POST "https://chat.devinotele.com/api/sign-in/" \
  -H "accept: */*" \
  -H "authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=="

Параметры ответа

При успешной авторизации сервис возвращает параметр result в значении null и HTTP-статус 200.

Health Check

Для проверки метода авторизации агент может воспользоваться методом POST ​/api​/healthcheck, передавая данные авторизации в заголовке.

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

curl -X POST "https://chat.devinotele.com/api/healthcheck/" \
  -H "accept: */*" \
  -H "authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=="

Параметры ответа

При успешной авторизации сервис возвращает параметр result в значении null и HTTP-статус 200.