API Ботов

В SimpleOne API ботов позволяет интегрировать экземпляр со сторонними сервисами (такими как мессенджеры, системы ИИ и так далее) для решения различных бизнес-задач в зависимости от запроса. Например, при создании инцидента ответственная группа получает уведомление в определенном мессенджере с указанной темой.

Для интеграции со сторонним сервисов выполните следующие шаги:

1. Обеспечьте подготовку на другой стороне (зарегистрируйтесь, если необходимо, получите токен авторизации, проверьте документацию по API).
2. Создайте запись типа бота.
3. Настройте методы REST, используемые для взаимодействия со сторонним сервисом. 
4. Настройте экземпляр бота.
5. Настройте параметры маршрутизации.
6. Настройте правила маршрутизации.

Создание типа бота

Тип бота — это связующий элемент для методов и экземпляров бота. При создании вы можете указать, какие боты могут использовать настроенные методы, и наоборот.

Чтобы создать новый тип бота, выполните следующие действия:

1. Перейдите в API ботов → Типы ботов. 
2. Нажмите Создать и укажите в поле Наименование название типа бота.
3. Нажмите Сохранить или Сохранить и выйти, чтобы применить изменения.

Настройка REST методов бота

Настройте методы REST API, предоставляемые сторонней системой, для взаимодействия с ней. Методы бота привязаны к правилам маршрутизации и параметрам маршрутизации.

Чтобы создать и настроить новый метод бота, выполните следующие действия:

1. Перейдите в API ботов → Методы ботов. 
2. Нажмите Создать и заполните поля.
3. Нажмите Сохранить или Сохранить и выйти, чтобы применить изменения.

Поля формы Метод бота

authorization:Bearer <token>; Content-Type:application/json

{
"channel": "<routing_parameter_0>",
"text": "<content>",
"thread_ts": "<routing_parameter_1>",
}

Настройка экземпляра бота

Создайте экземпляр бота, чтобы продолжить настройку интеграции, используйте методы бота, правила маршрутизации.

Чтобы создать нового бота, выполните следующие действия:

1. Перейдите в API ботов → Боты. 
2. Нажмите Создать и заполните поля.
3. Нажмите Сохранить или Сохранить и выйти, чтобы применить изменения.

Поля формы Бот

Настройка параметров маршрутизации

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

Основная цель этой функциональности – настройка корреляции между значением колонки при срабатывании правила маршрутизации бота и значением колонки, используемым в теле запроса.

Чтобы создать параметр маршрутизации, выполните следующие действия:

1. Перейдите в API ботов → Параметры маршрутизации. 
2. Нажмите Создать и заполните поля.
3. Нажмите Сохранить или Сохранить и выйти, чтобы применить изменения.

Поля формы Параметр маршрутизации

Настройка правил маршрутизации бота 

Таблица Правила маршрутизации ботов содержит условия и правила для срабатывания. при выполнении условий триггер выполняет запрос к внешней службе. Историю запросов можно найти в области связанных списков для каждой записи.

Чтобы создать правило маршрутизации, выполните следующие действия:

1. Перейдите в API ботов → Правила маршрутизации ботов. 
2. Нажмите Создать и заполните поля.
3. Нажмите Сохранить или Сохранить и выйти, чтобы применить изменения.

Поля формы Правило маршрутизации бота

История запросов ботов

Чтобы просмотреть историю обращений к сторонним сервисам, выполните следующие шаги:

1. Перейдите в API ботов → История запросов ботов. 
2. Нажмите на запись, которую вам нужно просмотреть.

Поля формы История запросов бота