Setting flespi token and region via API

This article describes how to configure flespi integration settings using the Remote API. These settings correspond to the flespi settings section on the Security tab in the user settings of the monitoring system. The flespi token is required for sending commands to flespi-type devices, or some flespi-based integrations, such as OEM or tachograph data streaming.

The flespi integration settings are stored as custom properties of the top account user item. The item/update_custom_property method is used to manage the following custom properties: flespi_token (flespi Master token), flespi_token_dc (data center region code), and flespi_region (full region configuration in JSON format).

This method works both for Wialon Hosting and Wialon Local. The only difference is the request host: https://hst-api.wialon.com for Wialon Hosting, or the URL of your monitoring site for Wialon Local.

These properties must be set on the top account user item, not on a unit or resource. The user performing the request must have the Edit not mentioned properties (ADF_ACL_ITEM_EDIT_OTHER, bit 0x80) access right to the top account user.

Use the core/search_items request to find the system ID of the top account user.

https://hst-api.wialon.com/wialon/ajax.html?svc=core/search_items&params={"spec":{"itemsType":"user","propName":"sys_name","propValueMask":"<top_account_name>","sortType":"sys_name"},"force":1,"flags":1,"from":0,"to":0}&sid=SESSION_IDENTIFIER

The system ID is returned in the id parameter of the response. Let’s assume it has a value of 600003506.

Use the item/update_custom_property request to set the flespi Master token.

https://hst-api.wialon.com/wialon/ajax.html?svc=item/update_custom_property&params={"itemId":600003506,"name":"flespi_token","value":"YOUR_FLESPI_MASTER_TOKEN"}&sid=SESSION_IDENTIFIER

{
  "n": "flespi_token",
  "v": "YOUR_FLESPI_MASTER_TOKEN"
}

Set the flespi data center region code.

https://hst-api.wialon.com/wialon/ajax.html?svc=item/update_custom_property&params={"itemId":600003506,"name":"flespi_token_dc","value":"eu"}&sid=SESSION_IDENTIFIER

{
  "n": "flespi_token_dc",
  "v": "eu"
}

Set the full region configuration. This property contains the endpoints and service URLs for the selected flespi region.

https://hst-api.wialon.com/wialon/ajax.html?svc=item/update_custom_property&params={"itemId":600003506,"name":"flespi_region","value":"{\"apps\":{\"login\":\"https://flespi.io/login\"},\"cdn\":\"https://cdn.flespi.io\",\"default\":true,\"gw\":\"gw.flespi.io\",\"gw-ftp\":\"{channel-address}:21\",\"gw-ip\":\"185.213.2.30\",\"media\":\"https://media.flespi.io\",\"mqtt\":\"mqtt.flespi.io:8883\",\"mqtt-ws\":\"mqtt.flespi.io:443\",\"name\":\"eu\",\"registration-allowed\":true,\"rest\":\"https://flespi.io\"}"}&sid=SESSION_IDENTIFIER

The flespi_region value for the eu region contains the following configuration:

The JSON value must be properly escaped when passed as a string in the API request. All internal double quotes must be escaped with backslashes (\").

To verify the flespi settings, use the core/search_item request with the flag 0x00000002 (2) to retrieve the custom properties of the user item.

https://hst-api.wialon.com/wialon/ajax.html?svc=core/search_item&params={"id":600003506,"flags":3}&sid=SESSION_IDENTIFIER

The response includes the prp object containing all custom properties, where you can verify the flespi_token, flespi_token_dc, and flespi_region values.

To remove a flespi setting from a top account user, use the same item/update_custom_property method with an empty value:

https://hst-api.wialon.com/wialon/ajax.html?svc=item/update_custom_property&params={"itemId":600003506,"name":"flespi_token","value":""}&sid=SESSION_IDENTIFIER

After removal, the property no longer appears in the prp object returned by core/search_item.