Боты

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

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

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

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

---

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

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

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

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

---

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

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

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

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

Поле	Обязательно	Описание
Наименование	Да	Укажите название метода.
URL-суффикс	Нет	Укажите относительный путь в дополнение к URL-адресу запроса. Полный URL-адрес запроса объединяется из постоянной части, указанной в поле URL-адреса экземпляра бота, и этого суффикса URL-адреса.
Метод запроса	Да	Укажите способ запроса. Доступные опции: GET POST Чтобы добавить больше методов, настройте опции выбора для этого поля.
Тип бота	Нет	Укажите тип бота, который может использовать этот метод.
Параметр состояния	Нет	Определите параметр, который показывает, был запрос успешным или нет. Поле хранит строку, которую должно вернуть тело ответа, чтобы запрос считался успешным. Если поле не заполнено, запрос всегда будет считаться успешным (за исключением ошибок на экземпляре).
Заголовки	Нет	При необходимости укажите заголовки методов. Допустимо использование переменных в угловых скобках. В примере ниже вместо переменной будет подставлен токен от экземпляра бота: authorization:Bearer <token>; Content-Type:application/json
Содержимое	Нет	Укажите тело запроса. Разрешены переменные в угловых скобках. В следующем примере сообщение отправляется в канал обмена сообщениями, определенный переменной <routing_parameter_0>, и маршрутизируется в поток в этом канале, заданный переменной <routing_parameter_1>. Содержимое этого сообщения определяется переменной <content>. Эти переменные должны быть определены в правиле маршрутизации бота. Нумерация параметров маршрутизации начинается с 0.

Тело запроса

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

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

---

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

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

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

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

Поле	Обязательно	Описание
Наименование	Да	Укажите название бота.
Тип бота	Да	Укажите тип бота. Он включает в себя методы, которые может использовать этот бот.
Токен	Нет	Укажите токен, если бот имеет авторизованный доступ к стороннему сервису. Этот токен должен быть предоставлен поставщиком API.
URL	Да	Укажите URL-адрес для выполнения запросов. Эта часть URL является постоянной, в отличие от суффиксов URL, указанных для каждого метода бота.

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

---

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

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

Чтобы создать параметр маршрутизаци�