La API web de Samsara permite el acceso a todos sus datos en la nube de Samsara mediante una API de estilo RPC basada en HTTPS. Utilice la API para acceder a:
Se pueden solicitar datos históricos y en tiempo real para cualquier período de tiempo y frecuencia de muestreo
Datos de temperatura, humedad, potencia y módulo de entrada disponibles
El acceso a la API está habilitado para todos los clientes
La seguridad de autenticación es proporcionada por un token de API y un sistema de clave secreta
Datos entregados de forma segura en formato JSON sobre TLS
Las versiones de la API se publican periódicamente.
Para obtener información detallada sobre la API de Samsara, consulte el portal de desarrolladores en desarrolladores.samsara.com.
Puede administrar tokens de API para un acceso seguro a la API en el Fichas de API página de configuración. Para obtener información detallada sobre los tokens de API, consulte el Guía de autenticación.
Para crear un token de API, debe tener asignado un rol de administrador completo o administrador estándar o un Funciones personalizadas con los siguientes permisos.
Editar permisos para ver y editar tokens API
Editar permisos para crear, editar y eliminar usuarios, roles, etiquetas
En ambos casos, su función debe tener acceso para administrar toda la organización. Los roles que usan etiquetas para alcance reducido (también conocidos como administradores de nivel de etiqueta) no son suficientes.
Puede solicitar y eliminar tantos tokens de API como sea necesario.
Para configurar un token de API:
Seleccione el ícono de Configuración (
) en la parte inferior de su Samsara dashboard para ver la configuración del tablero.
-
Seleccione Identificadores de la API.
Hacer clic + Añadir un identificador de la API.
-
Defina las propiedades del token:
Introduce un descriptivo Nombre para su token API que describe el propósito principal.
Seleccione el nivel de Acceso a etiquetas por tu ficha. Para obtener más información sobre las etiquetas, consulte Etiquetas.
-
Seleccione un permiso Alcance para su token API:
Para obtener más información sobre cómo configurar los alcances de los tokens de API, consulte este guía en nuestro sitio para desarrolladores.
Para obtener más información sobre cómo crear correctamente tokens de API para integraciones de terceros, consulte este guía en nuestro sitio para desarrolladores.
Ahorrar tus cambios
-
Después de crear el token, cópielo como se muestra a continuación. El token se volverá ilegible después de que se actualice la página, así que asegúrese de registrar la cadena del token en una ubicación segura.
Si olvida copiar o pierde un token de API, puede generar una nueva cadena de token.
Nota
Si hay una integración que utiliza activamente un token de API, se interrumpirá cuando regenere este token de API. Esto se debe a que la clave anterior se eliminará y se reemplazará con una clave nueva. Tome las debidas precauciones antes de confirmar.
Seleccione el ícono de Configuración (
Seleccione Identificadores de la API.
-
En el menú de más acciones ( ... ), Seleccione Regenerate (Regenerado).
Hacer clic Copy to Clipboard (Copiar al portapapeles) para copiar el nuevo código y grabarlo.
Reemplace el token de API en cualquier lugar donde esté en uso.
Puede actualizar la versión del token API en su consola de administración. Samsara solo incrementa la versión de la API cuando hay un cambio importante en la API.
Ejemplos de cambios importantes incluyen:
Agregar un parámetro de solicitud obligatorio a los métodos API existentes
Eliminación de propiedades de respuestas de API existentes
Para cambios no importantes, estos serán accesibles en todas las versiones de la API.
Ejemplos de cambios no disruptivos incluyen:
Adición de nuevos recursos API
Agregar nuevos parámetros de solicitud opcionales a los métodos API existentes
Adición de nuevas propiedades a las respuestas de la API existentes
Cambiar el orden de las propiedades en las respuestas de API existentes
Cambiar la longitud o el formato de los ID de objetos u otras cadenas opacas
Puede encontrar la versión en la página de tokens API en el tablero:
La actualización de su versión de API afectará las llamadas de API que realice sin un encabezado de Samsara-Version: los parámetros que puede enviar y la estructura de los objetos devueltos.
Puede probar una versión más nueva para una llamada API configurando el encabezado Samsara-Version. En el código de ejemplo a continuación, un usuario con <2018-01-01 token> podría hacer un único solicitud de la 2019-02-22 versión pasando un Versión X-Samsara Encabezado HTTP 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 Mejora en su tablero de Samsara. Esto cambia la versión utilizada por las llamadas a la API sin el encabezado Samsara-Version.
