Для интеграции необходимо следующее:
- Документация API.
- Понимание какие задачи должен выполнять бот, какую информацию запрашивать или предоставлять.
- (Опционально) Тестовый аккаунт.
Документация по работе с API содержит подробные инструкции, примеры кода и другую информацию, которая помогает разработчикам интегрироваться с сервисом или приложением. Документация определяет:
- какие запросы и ответы принимаются программой;
- какие операции можно выполнять;
- какие данные можно передавать и т. д.
Благодаря API становится возможной интеграция различных приложений, сервисов и систем для обмена информацией и выполнения задач.
Существует несколько способов найти API документацию:
- на сайте сервиса, в разделе «для разработчиков»;
- по запросу у технической поддержки сервиса;
- в интернете, используя поисковые системы и API библиотеки.
API должно быть хорошо задокументировано, чтобы разработчики быстро разобрались в его использовании. Включите описание эндпоинтов, методов, параметров, ответов и примеры.
Документация API должна содержать в себе:
- Эндпоинты — это URL-адреса, по которым можно отправлять запросы к API. Каждый эндпоинт соответствует определенному действию или операции, которую можно выполнить.
- Методы запросов: определяют тип действия, которое нужно выполнить с ресурсами API. Например, методы GET для получения данных, POST для создания новых данных, PUT для обновления данных, DELETE для удаления данных и т. д.
- Аутентификация — механизмы безопасности, которые подтверждают легитимность запросов к API. Это может включать в себя токены доступа, ключи API, базовую аутентификацию и другие методы;
- Формат данных: API возвращает данные в определенном формате, как правило, в формате JSON или XML. Отдавайте предпочтение формату JSON для интеграции с TWIN, так как использование XML усложнит дальнейшую работу.
Нажмите, чтобы посмотреть пример формата XML
Запрос:
<req>
<query>Виктор Иван</query>
<count>7</count>
</req>
Ответ:
<SuggestResponse>
<suggestions>
<value>Иванов Виктор</value>
<unrestricted_value>Иванов Виктор</unrestricted_value>
<data>
<surname>Иванов</suгname>
<name>Виктop</name>
<patronymic/>
<gender>MALE</gender>
</data>
</suggestions>
<suggestions>
<value>Иванченко Виктор</value>
<unrestricted_value>Иванченко Виктор</unrestricted_value>
<data>
<surname>Иванченко</surname>
<name>Виктop</name>
<patronymic/>
<gender>MALE</gender>
</data>
</suggestions>
<suggestions>
<value>Виктор Иванович</value>
<unrestricted_value>Виктор Иванович</unrestricted_value>
<data>
<surname/>
<name>Виктop</name>
<patronymic>Иванович</patronymic>
<gender>MALE</gender>
</data>
</suggestions>
</SuggestResponse>
Нажмите, чтобы посмотреть пример формата JSON
Запрос:
{
"query": "Виктор Иван",
"count": 7
}
Ответ:
{
"suggestions": [
{
"value": "Иванов Виктор",
"unrestricted value": "Иванов Виктор",
"data": {
"surname": "Иванов",
"name": "Виктор",
"patronymic": null,
"gender": "MALE"
}
},
{
"value": "Иванченко Виктор",
"unrestricted value": "Иванченко Виктор",
"data": {
"surname": "Иванченко",
"name": "Виктор",
"patronymic": null,
"gender": "MALE"
}
}
]
}
При разработке интеграции бота с внешней системой важно понимать, какие задачи бот должен выполнять и как он будет взаимодействовать с системой. Ниже приведены ключевые моменты и вопросы, которые помогут глубже разобраться в сути интеграции, чтобы правильно спланировать работу бота и понять, какую информацию запрашивать или предоставлять.
Определите как бот будет взаимодействовать с внешними системами. Ответьте на следующие вопросы:
- Будет ли бот запрашивать данные из внешней системы? Если да, то какие именно данные необходимы для его работы (например, информация о клиентах, статус записи, доступные слоты для записи)?
- Нужно ли боту отправлять данные во внешнюю систему? Например, может ли бот создавать или обновлять записи, запускать процессы или передавать статус завершения действия?
- Какие конкретные действия бот должен инициировать внутри внешней системы (например, создание задания, добавление кандидатов, отмена или подтверждение записи)?
Пример:
Бот может запрашивать информацию о записях клиентов и отправлять изменения, такие как подтверждение или отмена визита, в систему управления.
Убедитесь как внешняя система будет инициировать взаимодействие с ботом:
- Может ли внешняя система сама запускать процессы в боте (например, создание задачи на обзвон или передачу информации о клиенте для последующего звонка)?
- Как именно будет происходить взаимодействие — передача данных по API, обмен сообщениями через очередь, или другой способ?
Пример:
После создания записи в системе, бот автоматически получает задачу на звонок клиенту для подтверждения или отмены визита.
Для успешной интеграции необходимо четко описать бизнес-процессы, которые бот должен автоматизировать. Это поможет лучше понять цели интеграции и определить последовательность действий:
- Опишите, что запускает действия бота (например, входящий звонок, задача на обзвон, создание записи).
- Какие задачи должен выполнять бот? Например:
- Приветствие клиента.
- Подтверждение или отмена записи.
- Запись клиента на процедуру или изменение времени визита.
Пример бизнес-процесса:
- Клиент совершает звонок в компанию.
- Бот принимает звонок и ищет информацию о клиенте во внешней системе.
- Если клиент найден, бот приветствует его по имени. Если не найден — использует альтернативное приветствие.
- Бот предлагает доступные слоты для записи или возможность переноса/отмены записи.
- Результат (подтверждение или отмена) передается обратно во внешнюю систему для обновления записи.
Определите, есть ли особые предпочтения или требования по способу интеграции двух систем:
- Какой формат данных предпочтителен для передачи между сервисами (JSON, XML)?
- Есть ли ограничения по частоте или объему запросов?
- Какой метод интеграции будет удобнее: прямое подключение через API, использование вебхуков или событийная модель?
Для дальнейшей работы команда интеграции может запросить тестовый доступ/кабинет к работе с API для того, чтобы протестировать все доступные методы.
Какие есть виды интеграции?
- Интеграция через запросы к серверу внутри сценария. Этот способ позволяет боту взаимодействовать с удаленным сервером для получения данных или выполнения определенных действий. Бот может отправлять запросы на сервер и получать ответы, что помогает обновлять информацию или реагировать на изменения без необходимости обновления всей страницы.
Например, бот может запросить список новых сообщений с сервера или обновить данные на стороне пользователя в реальном времени.
Подробнее об интеграции через запросы к серверу читайте в статье Запрос к серверу.
- Готовая интеграция через ЛК:
- Интеграция через собственное приложение, где бот может быть встроен в ваше мобильное или веб-приложение, что позволяет пользователям взаимодействовать с ним прямо внутри приложения.
Например, в мобильном приложении для заказа еды бот может помочь пользователям выбирать блюда, оформлять заказы или предоставлять рекомендации, оставаясь внутри вашего приложения.
-
Создание сервиса для интеграции, который будет служить посредником между вашей системой и платформой TWIN. Он будет обрабатывать и форматировать данные для корректной передачи информации между двумя системами, что обеспечит бесперебойное взаимодействие.
-
Создание полноценной интеграции между платформами. Если вам нужна полная интеграция платформы TWIN с другой системой, свяжитесь с представителями этой платформы для обсуждения возможностей интеграции. После этого мы сможем организовать встречу для дальнейшего сотрудничества и разработки интеграции.
Что делать, если нет документации API?
Если документация API скрыта и/или недоступна по запросу в техподдержку, есть два варианта:
- Интеграция напрямую с сервисом. В этом случае вам нужно запросить встречу с представителем площадки для дальнейшего обсуждения.
- Если интеграция с сервисом невозможна, то стоит рассмотреть альтернативные варианты или обратиться за помощью к специалистам.
Как найти документацию API?
Найти документацию можно:
- на официальном сайте сервиса или приложения в разделе «Документация» или «API»;
- в разделе «Поддержка» или «Контакты», где могут быть ссылки на документацию;
- выполнив поиск по ключевым словам, таким как «API», «документация», «разработка» и название сервиса или приложения;
- обратившись в службу поддержки или к сообществу разработчиков;
- поискав ее на GitHub или других ресурсах с открытым исходным кодом.
Какие сценарии предусмотрены для автоматизации процессов?
Боты могут автоматизировать множество процессов, вот некоторые из сценариев автоматизации:
-
Создание и управление лидами.
- Автоматическое создание лида: Бот создает нового лида в CRM, основываясь на входящих данных, например, из заполненной формы на сайте.
- Обновление статуса лида: Статус лида обновляется в зависимости от взаимодействий с клиентом (например, после звонка).
-
Обработка входящих запросов и взаимодействие с клиентами.
Сценарии:
- Автоматические ответы на частые вопросы: Бот предоставляет заранее настроенные ответы на популярные вопросы клиентов.
- Запуск опросов и сбор отзывов: Бот проводит опросы после завершения сделки и собирает отзывы для анализа.
-
Интеграция с другими системами.
Сценарии:
- Синхронизация данных между системами: Бот автоматически синхронизирует данные (например, обновление контактной информации в CRM и системе рассылок).
- Запуск бизнес-процессов: По завершении сделки бот может автоматически запустить процесс выставления счета.
-
Обработка заявок и запросов
Сценарии:
- Автоматическая обработка заявок: Бот классифицирует и перенаправляет заявки на соответствующих сотрудников.
- Создание и обновление запросов: Бот создает тикеты в системе поддержки на основе запросов из чатов и обновляет их статус в реальном времени.
*Деятельность организации Meta Platforms Inc. и ее продуктов Instagram и Facebook запрещена в Российской Федерации.