Клиент REST API

В SimpleOne вы можете использовать REST клиент для интеграции системы со сторонними службами с помощью их REST API. Чтобы связать такую службу с вашим экземпляром SimpleOne, выполните следующие действия:

1. Создайте необходимые REST-запросы в Клиент REST API → Запросы.
2. Запланируйте их регулярное выполнение с помощью любого удобного инструмента.

Пример использования

Вам необходимо интегрироваться с одним из популярных мессенджеров. Для этого выполните следующие шаги:

1. Создайте REST запрос в соответствующем разделе.
2. Добавьте связанные заголовки запроса.
3. Добавьте связанные методы запроса.
4. При необходимости укажите соответствующие параметры методов запроса.
5. Укажите профили аутентификации, если этого требует интеграция с сервисом.

/* Создайте запрос 'Telegram'в таблице Запросы REST (sys_rest_requests) и метод 'Send Message' в таблицы Методы REST (sys_rest_request_method), связанный с запросом 'Telegram'.
Также создайте параметры 'chat_id' и 'text' в Параметрах метода REST (sys_rest_request_method_param), связанные с методом 'Send Message'.
*/
 
const request = sws.restRequestV1('Telegram', 'Send Message');
request.setStringParameter('chat_id', '123456789');
request.setStringParameter('text', 'telegram');
const response = request.execute();
 
// OR
 
const request = sws.restRequestV1();
request.setRequestUrl('https://api.telegram.org/bot1860462740:AAHyP6BMH2Mh-cXezrTVu2sJUoNYvimMRMQ/sendMessage');
request.setQueryParameter('chat_id', '123456789');
request.setQueryParameter('text', 'telegram');
const response = request.execute()

Запросы REST

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

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

Поля формы Запрос REST

Чтобы получить список доступных запросов REST, перейдите в раздел Клиент REST → Запросы.

Заголовки запросов REST

Создайте заголовок запроса и привяжите его к определенному запросу для отправки некоторой информации с запросом.

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

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

Поля формы Заголовок запроса REST

Чтобы получить список доступных заголовков запросов REST, перейдите в раздел Клиент REST → Заголовки.

Методы REST

Эта функциональность используется, когда вам нужно реализовать новый метод в вашем запросе REST. Например, если вы используете какой-то погодный сервис, вы можете реализовать метод для возврата погоды в вашем городе.

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

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

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

Чтобы получить список доступных методов запросов REST, перейдите в раздел Клиент REST → Методы.

Параметры методов REST

Укажите параметры для вашего настроенного метода запроса REST. В приведенном выше примере об интеграции с мессенджером Slack вам нужно будет отправить некоторые параметры, чтобы получить ответ, например, get_id, by_email и так далее.

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

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

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

Чтобы получить список доступных методов запросов REST, перейдите в раздел Клиент REST → Методы.

Профили аутентификации

При выборе типа Базовая аутентификация ваш запрос будет требовать аутентификации во время обработки. Для этого необходимо предоставить соответствующие данные аутентификации. 

В SimpleOne данные аутентификации хранятся в парах, называемых «базовыми профилями аутентификации». Эти профили содержат имена пользователей и пароли.

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

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

Поля формы Профиль аутентификации (базовый)

Чтобы получить список доступных профилей, перейдите в раздел Клиент REST → Профили аутентификации.