Conceptos básicos de API

La API web de Samsara permite el acceso a todos sus datos en la nube de Samsara a través de una API de estilo RPC basada en HTTPS. Puede encontrar información detallada en la Guía de API aquí: developers.samsara.com

Puntos clave:

• Se pueden solicitar datos históricos y en tiempo real para cualquier periodo de tiempo y frecuencia
• Módulo de entrada de datos de temperatura, humedad y alimentación disponible
• El acceso a la API está habilitado para todos los clientes
• La autenticación de seguridad se proporciona mediante un sistema de clave secreta y token de API
• Los datos se facilitan de forma segura en formato JSON a través de TLS

Crear tokens de API

Los tokens de API para un acceso seguro a la API se pueden ver y crear en la página Configuración de tokens de API. A continuación, se indican las instrucciones para configurar un token de API:

1. En el panel de Samsara, vaya aConfiguración> tokens de API. 
2. Haga clic en + Añadir un token de API para crear un nuevo token.

• Seleccione un nombre para su token de API. Se recomienda crear un nuevo token de API con un nombre descriptivo para cada aplicación que cree.
• Seleccione un ámbito de permisos para su token de API: Administrador con acceso de solo lectura o Administrador con todos los accesos (Full Admin). 

3. Seleccione Guardar una vez que haya indicado un Nombre y un Ámbito de Permiso. 

Puede solicitar y eliminar tantos tokens de API como sea necesario. 

Las versiones de API se publican periódicamente y puede encontrar más información sobre el control de versiones enhttps://developers.samsara.com/.

Tenga en cuenta que los administradores con acceso de solo lectura no tienen acceso para ver o crear tokens de API en el panel de Samsara. 

Actualizar tokens de API

Puede actualizar la versión del token de API en la consola de administración. Samsara solo incrementa la versión de la API cuando hay un cambio radical en la API.

Algunos ejemplos de cambios radicales son: 

• Añadir un parámetro de solicitud obligatoria a los métodos API existentes
• Eliminar propiedades de respuestas API existentes

Los cambios no radicales serán accesibles en todas las versiones de la API.

Algunos ejemplos de cambios no radicales son:

• Añadir nuevos recursos de API
• Añadir nuevos parámetros de solicitud opcionales a los métodos de API existentes
• Añadir nuevas propiedades a las respuestas API existentes
• Cambiar el orden de las propiedades en las respuestas API existentes
• Cambiar la longitud o el formato de los identificadores de objetos u otras cadenas opacas

Cómo actualizar su versión de API

Puede encontrar la versión en la página de tokens de API en el panel de control: 

La actualización de su versión de API afectará a las llamadas de API que realice sin un encabezado de la versión de Samsara: los parámetros que puede enviar y la estructura de objetos devueltos. 

Puede probar una versión más reciente para una llamada API estableciendo el encabezado de la versión de Samsara. En el código de ejemplo siguiente, un usuario con el token <2018-01-01> podría realizar una solicitud única para la versión 2019-02-22 pasando un encabezado HTTP de versión de Samsara X con la versión de marca de fecha deseada:

GET -H "X-Samsara-Version: 2019-02-22" https://api.samsara.com/v1/fleet/list?access_token=<2018-01-01 token>

Una vez que esté seguro de que su código puede manejar la última versión, haga clic en el botón "Actualizar" de su panel. Esto cambia la versión utilizada por las llamadas API sin encabezado Samsara-Version.