...

remove app MyApp

REST Methods

Для каждого приложения можно перечислить методы, которые будут вызываться у Web-сервера по REST/HTTP.
Полный список методов доступен по команде:

show rest-methods

Для включения и исключения REST-методов из приложения используются команды:

• show app-rest-methods
• remove app-rest-method
• add app-rest-method

Если метод добавлен в приложение, он будет задействован в интеграции и будет вызываться каждый раз, когда этого требует WCS сервер.
Например, если добавлен метод ConnectionStatusEvent, то WCS будет вызывать REST URL http://localhost/ConnectionStatusEvent каждый раз при коннекте нового пользователя и передавать Web-серверу необходимые данные. Для более подробного описания работы REST API, см. документацию Web Call Server - Call Flow.

Если же метод не добавлен в приложение, REST запроса Web-серверу не последует. Например при коннекте нового пользователя не будет обращения к REST URL http://localhost/ConnectionStatusEvent.

Команда show app-rest-methods

Используется для вывода активных методов приложения.

Параметры:
<app_name> имя приложения, обязательный параметр

Пример:

show app-rest-methods MyApp

Команда add app-rest-method

Используется для добавления метода к приложению. Добавлять методы к приложению может только пользователь которому принадлежит приложение, либо пользователь который состоит в супер группе.

Параметры:
<app name> имя приложения, обязательный параметр
<rest method> имя метода (с вывода команды show app-rest-methods), является обязательный если не указан ключ -а
[-a | --all] добавить все доступные методы к приложению

Пример:

add app-rest-method MyApp ConnectionStatusEvent
add app-rest-method -a MyApp

Команда remove app-rest-method

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

Параметры:
<app name> имя приложения, обязательный параметр
<rest method> имя метода (с вывода команды show app-rest-methods), является обязательным если не указан ключ -а
[-a | --all] исключить все методы добавленные к приложению

Пример:

remove app-rest-method MyApp ConnectionStatusEvent
remove app-rest-method -a MyApp

Примеры

Добавление приложения для существующего пользователя bob

...

1. Добавление приложения

Code Block
language bash theme RDark
add app -o bob BobsApp bobAppKey "http://bobs_web_server.example.com/app"

2. Добавление методов к приложению

theme

Code Block
language	bash
	RDark
add app-rest-method BobsApp ConnectionStatusEvent add app-rest-method BobsApp ErrorStatusEvent

Изменение приложения, добавление данных для HTTP аутентификации, изменение HTTP адреса

update app -u bobs_app -p paSsw0rd BobsApp
update app -l "https://bobs_new_server.example.com/secureApp" BobsApp

Передаем приложение другому пользователю

...

Code Block
language bash theme RDark
update app -o alice BobsApp

2. Удаляем метод

Code Block
language bash theme RDark
remove app-rest-method BobsApp ErrorStatusEvent

Добавление/удаление всех методов приложения:

1. Удаление

remove app-rest-method -a BobsApp

2. Добавление

add app-rest-method -a BobsApp