Приложения

Приложения хранят REST URL web-сервера, с которым осуществляется интеграция. Кроме того приложения хранят другие настройки и данные.

...

:

Описания приложений хранятся в файле database.yml.

Управлять приложениями можно при помощи следующих команд:

...

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

...

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

Параметры:
<app name> имя приложения, обязательный параметр
<app key> уникальный ключ приложения, обязательный параметр
<app url> REST URL для интеграции с Web-сервером по WCS RESTful API, обязательный параметр
[-m | --m-class] основной класс для прямых вызовов, необязательный параметр
[-c | --c-class] основной класс для обратных вызовов, необязательный параметр
[-u | --u-rest] имя пользователя для HTTP аутентификации, необязательный параметр
[-p | --p-rest] пароль пользователя для HTTP аутентификации, необязательный параметр
[-o | --owner] пользователь которому должно принадлежать приложение, необязательный параметр

...

Используется для изменения существующего приложения в системе. Пользователь может изменить только свои приложения. Если пользователь состоит в супер группе он может менять любые приложения. Только пользователь из супер группы может изменить владельца приложения.

Параметры:
<app name> имя приложения, обязательный параметр
[-k | --key] уникальный ключ приложения
[-l | --url] REST URL для интеграции с Web-сервером по WCS RESTful API
[-m | --m-class] основной класс для прямых вызовов
[-c | --c-class] основной класс для обратных вызовов
[-u | --u-rest] имя пользователя для HTTP аутентификации
[-p | --p-rest] пароль пользователя для HTTP аутентификации
[-o | --owner] пользователь которому должно принадлежать приложение

...

Используется для удаления приложения. Приложение может удалить только пользователь которому оно принадлежит или пользователь состоящий в супер группе. Параметры:
<app name> имя приложения, обязательный параметр

...

remove app MyApp

REST

...

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

show rest-methods

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

...

-методы приложений

Управлять REST-методами определенного приложения можно при помощи следующих команд:

• add app-rest-methodsmethodremove
• show app-rest-methodmethodsadd
• appremove 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

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

Параметры:
<app _name> имя key> ключ приложения, обязательный параметр

...

show app-rest-methods MyAppdefaultApp

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

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

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

Пример:

add app-rest-method MyAppMyAppKey ConnectionStatusEventconnect
add app-rest-method -a MyAppMyAppKey

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

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

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

Пример:

remove app-rest-method MyAppMyAppKey ConnectionStatusEventconnect
remove app-rest-method -a MyApp

MyAppKey

Примеры

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

add app -o bob BobsApp bobAppKey "http://bobs_web_server.example.com/app"

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

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

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

update app -o alice BobsApp