Configurar el token y la región de flespi mediante la API

En este artículo se describe cómo configurar los ajustes de la integración con flespi mediante la Remote API. Estos ajustes corresponden a la sección Ajustes de flespi de la pestaña Seguridad en los parámetros de usuario del sistema de rastreo. El token de flespi es necesario para enviar comandos a dispositivos de tipo flespi o para algunas integraciones basadas en flespi, como la transmisión de datos OEM o de tacógrafo.

Los ajustes de la integración con flespi se almacenan como propiedades personalizadas del elemento usuario de la cuenta de nivel superior. Para gestionar las siguientes propiedades personalizadas, se utiliza el método item/update_custom_property: flespi_token (token Master de flespi), flespi_token_dc (código de la región del centro de datos) y flespi_region (configuración completa de la región en formato JSON).

Este método funciona tanto en Wialon Hosting como en Wialon Local. La única diferencia es el host de la solicitud: https://hst-api.wialon.com para Wialon Hosting o la URL de su sitio de rastreo para Wialon Local.

Estas propiedades deben establecerse en el elemento usuario de la cuenta de nivel superior, no en una unidad ni en un recurso. El usuario que realiza la solicitud debe tener el derecho de acceso Modificar propiedades no mencionadas (bit 0x80) al usuario de la cuenta de nivel superior.

Utilice la solicitud core/search_items para encontrar el ID de sistema del usuario de la cuenta de nivel superior.

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

El ID de sistema se devuelve en el parámetro id de la respuesta. Supongamos que su valor es 600003506.

Utilice la solicitud item/update_custom_property para establecer el token Master de flespi.

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"
}

Establezca el código de la región del centro de datos de flespi.

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"
}

Establezca la configuración completa de la región. Esta propiedad contiene los endpoints y las URL de los servicios de la región de flespi seleccionada.

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

El valor de flespi_region para la región eu contiene la siguiente configuración:

El valor JSON debe escaparse correctamente cuando se pasa como cadena en la solicitud de API. Todas las comillas dobles internas deben escaparse con barras invertidas (\").

Para verificar los ajustes de flespi, utilice la solicitud core/search_item con el flag 0x00000002 (2) para obtener las propiedades personalizadas del elemento usuario.

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

La respuesta incluye el objeto prp con todas las propiedades personalizadas, donde puede verificar los valores de flespi_token, flespi_token_dc y flespi_region.

Para eliminar un ajuste de flespi de un usuario de la cuenta de nivel superior, utilice el mismo método item/update_custom_property con un valor vacío:

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

Después de eliminarla, la propiedad ya no aparece en el objeto prp que devuelve core/search_item.