Введение в SDK: создание учетных записей и объектов

В данной статье будет рассмотрено создание учетных записей и объектов при помощи Remote API. Эти элементы являются ключевыми при работе с Wialon, а их создание требует выполнения цепочки обязательных действий.

Также вам могут быть полезны:

• Статья Введение в SDK: базовые запросы.
• Портал для разработчиков с документаций и подробным описанием каждого запроса.
• Примеры готовых решений с использованием SDK из раздела Маркетплейс.
• Серия вебинаров Wialon API и SDK: обучающие видео.
• Коллекция примеров в приложении Postman для тестирования API-запросов.
• Раздел форума Собственные разработки под Wialon.

Перед выполнением данного действия необходимо вспомнить два важных термина:

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

Исходя из этого, чтобы создать учетную запись, необходимо:

1. Найти подходящий тарифный план.
2. Найти системный ID пользователя-создателя, под которым будет находиться будущий создатель учетной записи.
3. От имени найденного пользователя создать нового пользователя.
4. От имени нового пользователя создать ресурс.
5. Объединить нового пользователя, ресурс и тарифный план в учетную запись.

Рассмотрим запросы, которые понадобятся на каждом из этих шагов, на следующем примере: необходимо создать учетную запись с именем sdk_account, которая по иерархии сервиса будет находиться под учетной записью пользователя manager.

Используем запрос core/get_account_data.

https://hst-api.wialon.com/wialon/ajax.html?svc=core/get_account_data&params={"type":1}&sid=ИДЕНТИФИКАТОР_СЕССИИ

В отличие от других элементов, тарифный план не имеет системного ID. При необходимости ссылаться на него уникальным параметром является имя.

Имена назначенных тарифных планов будут отображаться в ответе на запрос в параметре subPlans. Предположим, что мы будем использовать тарифный план с именем standard_client.

Если в ответе не отображаются тарифные планы, то необходимо проверить, обладает ли учетная запись правами дилера и назначены ли на нее тарифные планы.

Используем запрос core/search_items.

https://hst-api.wialon.com/wialon/ajax.html?svc=core/search_items&params={"spec":{"itemsType":"user","propName":"sys_name","propValueMask":"manager","sortType":"sys_name"},"force":1,"flags":1,"from":0,"to":0}&sid=ИДЕНТИФИКАТОР_СЕССИИ

Системный ID пользователя будет отображаться в ответе на запрос в параметре id. Предположим, он будет иметь значение 11111.

Используем запрос core/create_user.

https://hst-api.wialon.com/wialon/ajax.html?svc=core/create_user&params={"creatorId":11111,"name":"sdk_account","password":"Pa%24%24w0rd","dataFlags":1}&sid=ИДЕНТИФИКАТОР_СЕССИИ

Так как по требованиям безопасности пароль должен содержать спецсимволы, то они должны быть закодированы для передачи в URL. | | “dataFlags”:1 | В качестве ответа будут отображены только основные свойства нового пользователя. |

Системный ID пользователя будет отображаться в ответе на запрос в параметре id. Предположим, он будет иметь значение 22222.

Используем запрос core/create_resource.

https://hst-api.wialon.com/wialon/ajax.html?svc=core/create_resource&params={"creatorId":22222,"name":"sdk_account","dataFlags":1,"skipCreatorCheck":0}&sid=ИДЕНТИФИКАТОР_СЕССИИ

Системный ID ресурса будет отображаться в ответе на запрос в параметре id. Предположим, он будет иметь значение 33333.

Используем запрос account/create_account.

https://hst-api.wialon.com/wialon/ajax.html?svc=account/create_account&params={"itemId":33333,"plan":"standard_client"}&sid=ИДЕНТИФИКАТОР_СЕССИИ

Выше рассмотрены только минимальные необходимые шаги для появления учетной записи в системе. Для выполнения прочих настроек нужно использовать отдельные запросы из списка в документации.

Чтобы создать объект с помощью Remote API, необходимо:

1. Найти системный ID типа оборудования.
2. Найти системный ID пользователя-создателя, в учетной записи которого будет находиться будущий объект.
3. Создать объект.
4. Присвоить объекту уникальный ID.

Рассмотрим необходимые запросы на следующем примере: необходимо создать объект Delivery truck с типом оборудования Wialon IPS и уникальным ID 12345 в учетной записи пользователя sdk_account.

Используем запрос core/get_hw_types.

https://hst-api.wialon.com/wialon/ajax.html?svc=core/get_hw_types&params={"filterType":"name","filterValue":["Wialon%20IPS"],"includeType":0,"ignoreRename":1}&sid=ИДЕНТИФИКАТОР_СЕССИИ

Системный ID типа оборудования будет отображаться в ответе на запрос в параметре id. Предположим, он будет иметь значение 44444.

Системный ID одного типа оборудования может отличаться для разных сервисов Wialon Hosting и Wialon Local.

Используем запрос core/search_items.

https://hst-api.wialon.com/wialon/ajax.html?svc=core/search_items&params={"spec":{"itemsType":"user","propName":"sys_name","propValueMask":"sdk_account","sortType":"sys_name"},"force":1,"flags":1,"from":0,"to":0}&sid=ИДЕНТИФИКАТОР_СЕССИИ

Системный ID пользователя будет отображаться в ответе на запрос в параметре id. Предположим, он будет иметь значение 22222.

Используем запрос core/create_unit.

https://hst-api.wialon.com/wialon/ajax.html?svc=core/create_unit&params={"creatorId":22222,"name":"Delivery%20truck","hwTypeId":44444,"dataFlags":1}&sid=ИДЕНТИФИКАТОР_СЕССИИ

Системный ID объекта будет отображаться в ответе на запрос в параметре id. Предположим, он будет иметь значение 55555.

Используем запрос unit/update_device_type.

https://hst-api.wialon.com/wialon/ajax.html?svc=unit/update_device_type&params={"itemId":55555,"deviceTypeId":44444,"uniqueId":"12345"}&sid=ИДЕНТИФИКАТОР_СЕССИИ

С помощью данного параметра можно изменить тип оборудования объекта. | | “uniqueId”:“12345” | Уникальный ID объекта будет иметь значение 12345. |

Выше рассмотрены только минимальные необходимые шаги для появления объекта в системе. Для выполнения прочих настроек нужно использовать отдельные запросы из списка в документации.