Custom API
Custom API можно использовать для получения, передачи или обновления данных во внешних сервисах. Вы сможете настроить интеграции с сервисами, у которых есть API документация. Функцию нужно настроить по инструкции из документации выбранного вами сервиса.
Как настроить простую интеграцию через API
Section titled “Как настроить простую интеграцию через API”Разберем получение данных на примере Altegio - функция для получения всех товаров на определенном филиале и функция для добавления нового клиента в систему.
GET Запрос
Section titled “GET Запрос”- После того, как вы выбрали в отправке результатов Custom API, укажите метод запроса и адрес (ссылку), куда будет отправлен запрос. Для получения данных обычно используется запрос GET. Например:
- В параметры вызова (params) в данном случае указывается ID филиала. Если у вас несколько филиалов, вы можете добавить параметр функции и написать промпт, чтобы агент подбирал ID в зависимости от выбранного филиала.
- Заголовки запроса (headers) нужно указать то, что указано в документации сервиса. В нашем примере нам нужно указать Accept и Authorization. Accept задает формат, в котором мы получим ответ от сервиса.
Authorization содержит ваш персональный токен, который можно получить на вашем сервисе. В Altegio существует два вида токенов - Partner token и User token. Оба токена нужно получить в Altegio. Пример заполнения:
- При получении данных (GET запрос) обычно не указываются параметры в теле запроса (body). Поэтому оставляем этот блок пустым:
POST запрос
Section titled “POST запрос”- После того, как вы выбрали в отправке результатов Custom API, укажите метод запроса и адрес (ссылку), куда будет отправлен запрос. Для отправки данных обычно используется запрос POST. Например:
- В параметры вызова (params) в данном случае указывается ID филиала. Если у вас несколько филиалов, вы можете добавить параметр функции и написать промпт, чтобы агент подбирал ID в зависимости от выбранного филиала.
- Заголовки запроса (headers) нужно указать то, что указано в документации сервиса. В нашем примере нам нужно указать Accept, Content-Type и Authorization. Accept задает формат, в котором мы получим ответ от сервиса. Content-Type задает формат, в котором мы отправляем ответ сервису.
Authorization содержит ваш персональный токен, который можно получить на вашем сервисе. В Altegio существует два вида токенов - Partner token и User token. Оба токена нужно получить в Altegio. Пример заполнения:
- При отправке данных нужно указать поля, которые нужно заполнить, а также данные, которыми заполняются данные поля. Для добавления нового клиента нужно использовать поля name и phone:
