Справочный центр Wialon
Wialon для разработчиков Руководство пользователя Документация API apps create

create

Чтобы добавить приложение в сервис, используйте метод apps/create. Добавленное приложение появляется в списке приложений в окне Конфигурация Apps в CMS Manager.

Этот метод в Wialon Hosting может использовать только пользователь верхнего уровня.

Конечная точка

Copied!
svc=apps/create&params={
  "name": <text>,
  "description": <text>,
  "url": <text>,
  "flags": <uint>,
  "langs": <text>,
  "sortOrder": <int>,
  "requiredServicesList": <text>,
  "billingPlans": <text>
}

Параметры

Запрос должен содержать все следующие параметры. Если параметр не нужен для вашего приложения, укажите для него пустое значение ("" для текстовых параметров и 0 для числовых).

Параметр Описание
name Имя приложения. Не может быть пустым.
description Описание приложения. Оно также используется как описание услуги приложения. Можно оставить пустым.
url URL, по которому размещено приложение. Должен начинаться с http://, https:// или //.
flags Флаги приложения (дополнительные параметры URL). Возможные значения см. в разделе Флаги. Укажите 0, если они не нужны.
langs Языки интерфейса, для которых доступно приложение, через запятую, например "en,ru". Если значение пустое, приложение доступно для всех языков.
sortOrder Порядок сортировки приложения в списке.
requiredServicesList Имена услуг, необходимых для приложения, через запятую. Каждая услуга должна быть доступна в вашей учетной записи. Не ставьте запятую в конце списка. Можно оставить пустым.
billingPlans Имена тарифных планов, для которых доступно приложение, через запятую. Каждый тарифный план должен существовать в вашем сервисе. Можно оставить пустым.

Подробнее о параметрах приложения см. в разделе Apps.

Флаги

Параметр flags определяет, какие параметры добавляются к URL приложения, когда пользователь его открывает. Каждый флаг соответствует опции из списка дополнительных параметров URL в CMS Manager. Чтобы указать несколько флагов, сложите их значения. Например, у приложений из библиотеки значение 31 (0x1F): 0x1 + 0x2 + 0x4 + 0x8 + 0x10.

Значение Опция в CMS Manager Параметр, который добавляется к URL приложения
0x1 (1) Active SID sid=<ID сессии>. Авторизация по ID сессии: после обновления страницы пользователь остаётся в приложении.
0x2 (2) Current user user=<имя текущего пользователя>.
0x4 (4) Base URL baseUrl=<адрес API>, например, https://hst-api.wialon.com.
0x8 (8) Host URL hostUrl=<адрес, с которого пользователь открыл приложение>, например, https://hosting.wialon.com.
0x10 (16) Language lang=<язык интерфейса текущего пользователя>.
0x20 (32) Authorise hash authHash=<хеш>. Авторизация по хешу, созданному с помощью метода core/create_auth_hash: после обновления страницы пользователь выходит из приложения.

Чтобы пользователи могли войти в приложение, укажите флаг 0x1 (Active SID) или 0x20 (Authorise hash).

При создании приложения система также выполняет следующие действия:

  • создает в вашей учетной записи услугу app.<serviceName> (услуга Отображение в меню: <имя приложения> в CMS Manager);
  • добавляет эту услугу в тарифные планы, указанные в параметре billingPlans.

Пример

Copied!
svc=apps/create&params={
  "name": "My app",
  "description": "",
  "url": "https://example.com/app",
  "flags": 31,
  "langs": "",
  "sortOrder": 0,
  "requiredServicesList": "",
  "billingPlans": ""
}

В этом примере значение флагов 31 добавляет к URL приложения параметры sid, user, baseUrl, hostUrl и lang. Подробнее см. в разделе Флаги.

Ответ

Если запрос выполнен успешно, ответ возвращается в следующем формате:

Copied!
[
  <long>,   /* ID приложения */
  {
    "name": <text>,                  /* Имя приложения */
    "description": <text>,           /* Описание приложения */
    "url": <text>,                   /* URL приложения */
    "flags": <uint>,                 /* Флаги приложения */
    "sortOrder": <int>,              /* Порядок сортировки */
    "serviceName": <text>,           /* Имя услуги приложения без префикса "app." */
    "id": <long>,                    /* ID приложения */
    "langs": <text>,                 /* Языки интерфейса */
    "requiredServicesList": <text>,  /* Необходимые услуги */
    "billingPlans": <text>           /* Тарифные планы */
  }
]

Если запрос выполнить не удалось, возвращается код ошибки.

Коды ошибок

Код ошибки Описание
4 Неверные входные параметры, или один из параметров отсутствует.
7 Нет доступа: пользователь не является пользователем верхнего уровня, или сервис не является Wialon Hosting. Этот код также возвращается, если указаны неверные имя или URL, необходимая услуга или тарифный план недоступны, или приложение не удалось создать.

Если вы заметили ошибку в тексте, пожалуйста, выделите её и нажмите Ctrl+Enter.