API-коннекторы для динамических данных Chatbot

API-коннекторы

API-коннекторы позволяют вашему Chatbot вызывать внешние REST API прямо во время диалога для получения данных в реальном времени. Используйте их для поиска заказов, проверки остатков на складе, верификации аккаунтов или получения данных из любого сервиса с API. Chatbot запрашивает у посетителя нужные данные, вызывает ваш API, проверяет полученный ответ и выводит результат в виде диалога.

API-коннекторы доступны на тарифе Стандартный и выше. Они не включены в тарифы Бесплатный и Базовый.

Добавление API-коннектора

Откройте вашего ассистента в панели управления, раскройте блок Расширенные настройки под основными вкладками, выберите API-коннекторы и нажмите Добавить API-коннектор. API-коннекторы не являются Каналом или Функцией. Вы можете начать с готового шаблона или настроить собственный коннектор с нуля.

Поля конфигурации

Основные настройки

Поле	Описание	Обязательно
Name	Понятное имя для этого коннектора (например, "Order Lookup", "Inventory Check").	Да
URL	URL конечной точки API (например, `https://api.example.com/orders`).	Да
Method	HTTP-метод: `GET`, `POST`, `PUT`, `PATCH` или `DELETE`.	Да (по умолчанию: GET)
Headers (JSON)	Необязательные HTTP-заголовки в формате JSON (например, `{"Authorization": "Bearer abc123", "Content-Type": "application/json"}`). Должен быть валидный JSON.	Нет
Включен	Активен ли этот коннектор.	Да (по умолчанию: Включен)

Тело запроса (только для POST/PUT/PATCH)

Поле	Описание
Body Content Type	Формат тела запроса: `JSON` или `Form Data`.
Request Body Template	Шаблон тела запроса. Используйте подсказки вида `{email}`, `{order_id}`, которые соответствуют созданным вами полям.

Пример шаблона тела:

{
  "email": "{email}",
  "order_id": "{order_id}"
}

Поля

Поля определяют, какую именно информацию Chatbot должен запросить у посетителя перед вызовом API. Каждое поле содержит:

Свойство	Описание	Обязательно
Field Name	Идентификатор поля (например, `order_id`, `email`). Используется как подсказка в теле запроса.	Да
Type	Тип данных: `string`, `number`, `email` или `boolean`.	Да (по умолчанию: string)
Description (for AI)	Объясняет для AI назначение поля и то, как запросить его у посетителя.	Нет
Обязательно	Должен ли посетитель обязательно заполнить это поле перед отправкой запроса к API.	Нет

Примеры полей:

Имя	Тип	Описание	Обязательно
`order_id`	string	Номер заказа клиента, обычно начинается с ORD-	Да
`email`	email	Адрес электронной почты, указанный при оформлении заказа	Да

Правила валидации ответа

Правила валидации проверяют соответствие данных из ответа API данным, которые ввел посетитель. Это защищает от передачи конфиденциальных сведений чужого заказа или профиля.

Каждое правило содержит:

Свойство	Описание
Поле ввода	Поле, заполненное посетителем, по которому выполняется проверка (из списка ваших полей).
Путь в ответе	Путь к значению в ответе API (например, `billing.email`, `data.order.status`). Для вложенных объектов используйте точечную нотацию.
Сравнение	Тип проверки: `equals`, `equals (ignore case)`, `contains` или `not empty`.
Сообщение об ошибке	Текст, который отобразится посетителю при неудачной валидации (например, "Email адрес не совпадает с нашими записями").

Пример валидации:

Поле ввода	Путь в ответе	Сравнение	Сообщение об ошибке
email	billing.email	equals (ignore case)	Email адрес не совпадает с данными заказа. Пожалуйста, проверьте данные и попробуйте снова.

Промпт

Инструкции для AI о том, когда и как вызывать этот коннектор. Это ключевой параметр, по которому Chatbot определяет момент вызова API.

Пример промпта:

Use this connector when a customer asks about their order status, shipping 
information, or delivery date. Ask for their order ID and email address before 
making the API call. Present the order status, shipping method, and estimated 
delivery date in a friendly format.

Как это работает

Посетитель задает вопрос, соответствующий промпту коннектора (например, "Где мой заказ?")
Chatbot запрашивает обязательные поля (например, ID заказа, email)
Посетитель отправляет нужные данные
Chatbot выполняет запрос к API с полученными данными
Ответ проверяется правилами валидации
Если валидация пройдена, Chatbot возвращает данные посетителю в понятном текстовом виде

Объединение нескольких API-коннекторов в цепочки

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

Пример: Аутентификация + Получение данных

Коннектор 1, "Authenticate Customer": отправляет запрос на эндпоинт авторизации с почтой и паролем посетителя, получает в ответе токен доступа.
Коннектор 2, "Fetch Order Details": берет токен из первого ответа, отправляет запрос к закрытому эндпоинту API и забирает данные заказа.

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

Для настройки создайте каждый коннектор по отдельности, указав для каждого свой эндпоинт, поля и промпт. В промпте второго коннектора опишите зависимость от первого (например, "Use the authentication token from the Authenticate Customer connector to call this endpoint"). AI самостоятельно выстроит нужную последовательность.