La API web de Samsara permite el acceso a todos sus datos en la nube de Samsara utilizando una API de estilo RPC basada en HTTPS. Use la API para acceder a:
-
Datos en tiempo real e históricos para cualquier período de tiempo y frecuencia de muestreo que se pueda solicitar
-
Datos de temperatura, humedad, energía y módulo de entrada disponibles
-
El acceso a la API está habilitado para todos los clientes
-
La seguridad de autenticación se proporciona mediante un sistema de token de API y clave secreta
-
Datos entregados de forma segura en formato JSON sobre TLS
Las versiones de la API se lanzan periódicamente.
Para obtener información detallada sobre la API de Samsara, consulte el portal de desarrolladores en developers.samsara.com.
Puede gestionar los tokens de API para un acceso seguro a la API en la página de configuración de Tokens de API. Para obtener información detallada sobre los tokens de API, consulte la guía de autenticación.
Para crear un token de API, debe tener un rol de administrador con acceso total o administrador estándar o un Roles personalizados con los siguientes permisos.
-
Permisos de edición para ver y editar tokens de API
-
Permisos de edición para crear, editar y eliminar usuarios, roles, etiquetas
En ambos casos, su rol debe tener acceso para administrar toda la organización. Los roles que utilizan etiquetas para un alcance reducido (administradores a 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 del panel de Samsara para ver la configuración.
-
Seleccione Tokens de API.
-
Haga clic en + Agregar un token de API.
-
Defina las propiedades del token:
-
Ingrese un Nombre descriptivo para su token de API que describa el propósito principal.
-
Seleccione el nivel de Acceso a etiquetas para su token. Para obtener más información sobre las etiquetas, consulte Etiquetas.
-
Seleccione un Alcance de permisos para su token de API.
Para obtener más información, consulte los siguientes recursos en el portal de desarrolladores de Samsara:
-
Para establecer alcances para tokens de API, consulte Autenticación de API.
-
Para crear tokens de API para integraciones de terceros, consulte Tokens para integraciones de terceros.
-
-
-
Seleccione Guardar sus cambios.
-
Después de crear el token, cópielo como se muestra a continuación. El token se volverá ilegible después de actualizar la página, así que asegúrese de guardar 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 está utilizando un token de API, esta se interrumpirá cuando regenere este token de API. Esto se debe a que se eliminará la cadena anterior y se reemplazará por una nueva. Tome las precauciones adecuadas antes de confirmar.
-
Seleccione el ícono de Configuración (
-
Seleccione Tokens de API.
-
En el menú más acciones ( ... ) para el token de API, seleccione Regenerar.
-
Haga clic en Copiar al portapapeles para copiar el nuevo código y registrarlo.
-
Reemplace el token de API en cualquier lugar donde se esté utilizando.
Puede actualizar la versión del token de API en su consola de administrador. Samsara solo incrementa la versión de la API cuando hay un cambio disruptivo en la API.
Algunos ejemplos de cambios disruptivos pueden ser:
-
Agregar un parámetro de solicitud obligatorio a los métodos de API existentes
-
Eliminar propiedades de las respuestas de API existentes
En caso de cambios no disruptivos, estos estarán accesibles en todas las versiones de la API.
Algunos ejemplos de cambios no disruptivos pueden ser:
-
Agregar nuevos recursos de API
-
Agregar nuevos parámetros de solicitud opcionales a los métodos de API existentes.
-
Agregar nuevas propiedades a las respuestas de API existentes
-
Cambiar el orden de las propiedades en las respuestas de API existentes.
-
Cambiar la longitud o el formato de los identificadores de objetos u otras cadenas opacas.
Puede encontrar la versión en la página de tokens de API en el panel:
Actualizar su versión de la API afectará las llamadas a la API que realice sin un encabezado Samsara-Version: los parámetros que puede enviar y la estructura de los objetos devueltos.
Puede probar una versión más reciente para una llamada a la API configurando el encabezado Samsara-Version. En el código de ejemplo a continuación, un usuario con el token <2018-01-01> podría hacer una solicitud única para la versión 2019-02-22 pasando un encabezado HTTP X-Samsara-Version con la versión de fecha deseada:
GET -H "X-Samsara-Version: 2019-02-22" https://api.samsara.com/v1/fleet/list?access_token=<2018-01-01 token>
Después de estar seguro de que su código puede manejar la última versión, haga clic en Actualizar en su panel de Samsara. Esto cambia la versión utilizada por las llamadas a la API que no tienen el encabezado Samsara-Version.
Comentarios
0 comentarios
Inicie sesión para dejar un comentario.