Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents


Приложения

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

Приложения

Поле

Описание

name

Название приложения.

appKey

Уникальный идентификатор, который будет использоваться при коннекте с этим приложением со стороны клиента.

url

REST URL для интеграции с Web-сервером по WCS RESTful API.

owner

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

mainClass

Основной класс для прямых вызовов. Для глубокой интеграции и server-side разработчиков.

callbackClass

Основной класс для обратных вызовов. Для глубокой интеграции и server-side разработчиков.

restUsername

Имя пользователя для HTTP аутентификации REST.

restPassword

Пароль пользователя для HTTP аутентификации REST.

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

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

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

Команда show apps

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

...

Code Block
languagebash
themeRDark
remove app MyApp

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

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

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

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

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

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

Пример:

Code Block
languagebash
themeRDark
show app-rest-methods defaultApp

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

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

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

Пример:

Code Block
languagebash
themeRDark
add app-rest-method MyAppKey connect
add app-rest-method -a MyAppKey

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

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

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

Пример:

Code Block
languagebash
themeRDark
remove app-rest-method MyAppKey connect
remove app-rest-method -a MyAppKey

Примеры

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

...