SES. Руководство пользователя: различия между версиями
Материал из Флора AI
(Новая страница: « ======'''Общее описание'''====== Сервис предназначен для создания роботов и обеспечения их работы.») |
Нет описания правки |
||
| Строка 2: | Строка 2: | ||
======'''Общее описание'''====== | ======'''Общее описание'''====== | ||
Сервис предназначен для создания роботов и обеспечения их работы. | Сервис предназначен для создания роботов и обеспечения их работы. | ||
====== '''Термины и определения''' ====== | |||
Script engine service (SES) - сервис обеспечения работы и создания роботов. | |||
Swagger UI – интерактивная веб-консоль с кратким описанием методов АPI и возможностью выполнять запросы к сервису SES в реальном времени | |||
====== '''Описание методов API''' ====== | |||
Запросы осуществляются по протоколу HTTP 1.1 на адрес сервера с доступным сервисом SES. По умолчанию используется порт 6189/tcp. | |||
Авторизация запросов не требуется. HTTP-запросы должны содержать заголовок <code>"accept: application/json"</code> | |||
Ответ сервиса представляет собой JSON или текстовый документ в кодировке UTF-8, или двоичный файл. | |||
Содержимое документа зависит от результата выполнения запроса. При наличии ошибки в качестве ответа вернется переменная error=1 и описание в переменной message. Для удобства проверки методов по ссылке http://АДРЕС:6190 будет отображен интерфейс swagger со всеми методами с возможностью их проверки. | |||
{| class="wikitable" style="width: 110%" | |||
|+''Описание методов API'' | |||
! style="color:blue;width: 15%" |'''GET''' | |||
! colspan="3" style="width: 85%" |описание | |||
|- | |||
| colspan="2" style="width: 50%" |<small>Входные параметры </small> | |||
| colspan="2" style="width: 50%" |<small>выходные параметры</small> | |||
|- | |||
! style="color:green;width: 15%" |'''POST''' | |||
! colspan="3" style="width: 85%" |описание | |||
|- | |||
| colspan="2" style="width: 50%" |<small>Входные параметры </small> | |||
| colspan="2" style="width: 50%" |<small>выходные параметры</small> | |||
|} | |||
Версия от 15:50, 2 ноября 2024
Общее описание
Сервис предназначен для создания роботов и обеспечения их работы.
Термины и определения
Script engine service (SES) - сервис обеспечения работы и создания роботов. Swagger UI – интерактивная веб-консоль с кратким описанием методов АPI и возможностью выполнять запросы к сервису SES в реальном времени
Описание методов API
Запросы осуществляются по протоколу HTTP 1.1 на адрес сервера с доступным сервисом SES. По умолчанию используется порт 6189/tcp.
Авторизация запросов не требуется. HTTP-запросы должны содержать заголовок "accept: application/json"
Ответ сервиса представляет собой JSON или текстовый документ в кодировке UTF-8, или двоичный файл.
Содержимое документа зависит от результата выполнения запроса. При наличии ошибки в качестве ответа вернется переменная error=1 и описание в переменной message. Для удобства проверки методов по ссылке http://АДРЕС:6190 будет отображен интерфейс swagger со всеми методами с возможностью их проверки.
| GET | описание | ||
|---|---|---|---|
| Входные параметры | выходные параметры | ||
| POST | описание | ||
| Входные параметры | выходные параметры | ||