API адреса

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

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

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

Настройки

Отключение REST API

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

disable_rest_requests=true

Порты

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

http.port=8081
https.port=8444

В предыдущих версиях WebCallServer REST запросы обрабатывал административный модуль на портах 9091 и 8888 соответственно. Для того, чтобы существующие веб-приложения продолжали работать после обновления сервера, предусмотрены следующие настройки административного модуля в файле wcs-manager.properties

-Dmanager.rest_redirect_http_port=8081
-Dmanager.rest_redirect_https_port=8444

Авторизация

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

disable_rest_auth=false

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

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

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

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

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

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

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

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