API адреса

Web Call Server использует два URL-адреса для REST API

Для того чтобы вызвать REST-метод, сформируйте запрос следующего формата:

• Протокол: HTTP или HTTPS
• Content Type: application/json
• Метод: POST
• Тело запроса: JSON

Настройки

Порты

По умолчанию, REST HTTP  запросы принимаются на порту 8081, REST HTTPS - на порту 8444. Эти значения определяются следующими настройками в файле flashphoner.properties

http.port=8081
https.port=8444

Междоменные запросы

Междоменные запросы управляются следующими настройками в файле flashphoner.properties

rest_access_control_allow_origin=*
rest_access_control_allow_headers=content-type,x-requested-with
rest_access_control_allow_methods=POST

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

Авторизация

По умолчанию, REST API запросы обрабатываются без авторизации. При необходимости, может быть включена Basic авторизация при помощи следующего параметра в файле flashphoner.properties

disable_rest_auth=false

Пользователи REST API при включении авторизации управляются из командной строки ядра WCS.

Для междоменных запросов необходимо добавить заголовки при помощи следующей настройки в файле flashphoner.properties:

rest_access_control_headers=Access-Control-Allow-Origin: <origin>;Access-Control-Allow-Credentials: true;Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS;Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization

Здесь <origin>- источник запроса, например http://test.flashphoner.com.

Тестирование

Для тестирования можно использовать REST-клиент. Например Advanced REST Console для браузера Google Chrome.

На скриншоте приведен пример обращения к серверу с получением списка текущих потоков REST методом /stream/find_all

OpenAPI спецификация

В сборке 5.2.1343 добавлен интерфейс для отображения и тестирования REST API в соответствии с OpenAPI 3 спецификацией. Файл OpenAPI спецификации может быть загружен по адресу https://demo.flashphoner.com:8444/rest-api/openapi_spec в формате YAML, интерфейс доступен по адресу https://demo.flashphoner.com:8444/rest-api-spec/, где demo.flashphoner.com  - адрес WCS сервера

Каждый запрос можно развернуть и протестировать при помощи Swagger UI

Обязательные поля отмечены символом * на вкладке Schema