Подключите Aiva к собственным системам
Опишите запросы, которые принимает ваш собственный API, и Aiva использует эти запросы в диалогах, чтобы прочитать аккаунт клиента или выполнить запрос от имени клиента.
Задайте каждое действие, доступное Aiva
Укажите для каждого действия метод, путь и параметры, а также описание, которое подсказывает Aiva, когда вызывать это действие. Для подтверждённого клиента Assistify подставляет email клиента, поэтому Aiva читает только аккаунт этого клиента.
Вопросы о Custom API
К чему может подключаться Custom API?
К любому REST API, доступному из интернета. Аутентификация может быть ключом API в заголовке, bearer-токеном или базовой аутентификацией, а каждое действие отправляет запрос GET, POST, PUT, PATCH или DELETE.
Может ли Aiva изменять данные через мой API?
Да, если вы зададите действие, которое изменяет данные. Aiva вызывает только заданные вами действия, а каждый запрос, кроме GET, несёт ключ идемпотентности, поэтому повторный запрос не применяется дважды.
Как Aiva понимает, чей аккаунт читать?
Для действия, открытого подтверждённым клиентам, Assistify подставляет в выбранный вами параметр подтверждённый email клиента. Aiva никогда не выбирает и не видит это значение.
Что Aiva видит в ответе?
Сокращённый ответ: списки до первых 50 элементов, укороченные длинные тексты, а поля вроде аватаров и ссылок на скачивание удалены.
Какие тарифы включают Custom API?
Все тарифы. Ваши действия Aiva вызывает на тарифах, которые включают Aiva. Подробности приведены в сравнении тарифов.