Wialon for developers User guide API reference apps

apps

This section describes the methods for working with apps. Apps are web applications that users open from the Apps menu in the monitoring system. Using these methods, you can do the same as in the Apps configurator window in CMS Manager: get the list of apps, as well as add, edit, and delete them.

The methods of this section are available only in Wialon Hosting. Only the top user of the service can add, edit, and delete apps.

The section contains the following methods:

Method Description
check_top_service Checks if the current user is the top user of the service and can manage apps.
list Returns the list of apps available to the current user, or all the apps of the service.
create Adds an app.
update Changes the parameters of an app.
delete Deletes an app.

Managing apps

To add an app and make it available to users, do the following:

  1. Check if you can manage apps using the apps/check_top_service method.
  2. Add the app using the apps/create method. In the billingPlans parameter, specify the billing plans for which the app should be available.
  3. To change the app parameters later, get its ID using the apps/list method with "manageMode":1. Then use this ID in the apps/update or apps/delete method.

When you add an app, the system creates the app.<serviceName> service for it. In CMS Manager, this service is displayed in the Apps group on the Services tab of the account and billing plan properties in the format Display in menu: . If this service is disabled, the app is removed from the menu of the monitoring system, but the app itself remains available.

If you find a mistake in the text, please select it and press Ctrl+Enter.