Список REST-методов

<< Показать Оглавление >>

 

Список REST-методов

Выполнение запросов через WebSocket может быть не очень удобным в силу того, что WS подразумевает асинхронность.

В связи с тем, что часть операций больше соответствует синхронной модели запросов, предусмотрена альтернатива в виде REST.

Однако использование методов REST API не является обязательным: вы можете ограничиться лишь только WebSocket.

Протокол взаимодействия: HTTP.

Формат сообщений: JSON.

Вызов функций производится посредством запроса HTTP по следующему шаблону:

<метод><протокол>://<хост>:<порт>/<запрос>

Здесь:

<метод> — используемый метод HTTP (POST, GET, PATCH) зависит от вызываемой функции;

<протокол> — http;

<хост> — localhost;

<порт> — порт REST из настроек Voice2Med Client (по умолчанию 39256);

<запрос> — зависит от вызываемой функции и приводится в описании.

Примеры вызова:

http://localhost:39256/api/Theme

 

atten_yell

REST-запросы также доступны и при работе ИС напрямую с Dictation Server, но должны быть адресованы на порт, настроенный на сервере для обработки REST-запросов. По умолчанию на сервере используется порт 39255.