Crear una llave de API
En este artículo
Una llave de API le permite a otro sistema tuyo (un ERP, un sistema de despacho, un script) consultar o actualizar tu flota.
Antes de empezar
- Necesitas el rol Administrador.
- La llave se usa solo desde un servidor, porque las llamadas desde un navegador se rechazan.
Pasos
- Abre tu menú de usuario y entra a Mi cuenta.
- En Desarrolladores, abre Llaves de API.
- Toca Crear llave.
- Escribe un Nombre que diga qué sistema la va a usar, por ejemplo "ERP de despacho".
- Elige el Acceso.
- Con Solo lectura, el sistema consulta dispositivos, posiciones, reportes y geocercas.
- Con Lectura y escritura, también crea y cambia dispositivos, geocercas, conductores, grupos y mantenimiento.
- Si elegiste Lectura y escritura y el sistema tiene que mandar órdenes a los equipos, como pedir la posición, activa Enviar comandos. Una llave no puede mandar comandos de riesgo, como cortar el motor, porque esos solo se envían desde la app y con la confirmación de una persona.
- Elige el Vencimiento, que puede ser de 30, 90 o 180 días, 1 año o No vence. Si no lo cambias, la llave vence a los 90 días.
- Toca Crear llave.
- Toca Copiar llave y guárdala en un lugar seguro. La app te avisa con No la vas a volver a ver, porque después de cerrar esa ventana la llave no se vuelve a mostrar.
Usarla
En Cómo usarla están la URL base y un ejemplo. La llave va en el encabezado Authorization, así:
curl <URL base>/api/devices \
-H "Authorization: Bearer <tu llave>"
Ver documentación abre la referencia de la API, si tu instalación la tiene.
Rotar o revocar
- Rotar crea una llave nueva. La anterior sigue funcionando 7 días, para que alcances a cambiarla en tu sistema.
- Revocar la apaga al instante, y esto no se puede deshacer.
En la lista ves el Último uso … de cada llave y cuándo vence. Las revocadas y vencidas están en Revocadas y vencidas (…).
Si algo no sale
- "Ya tienes 25 llaves activas, que es el máximo. Para crear otra, primero revoca alguna que ya no uses."
- "Solo se puede rotar una llave activa." Las llaves vencidas o revocadas no se pueden rotar. En ese caso, puedes crear una nueva.
- Una llave que "No vence" dejó de funcionar. Una llave sin vencimiento se revoca sola si pasa un año sin usarse. En la lista aparece como Revocada tras un año sin uso, y puedes crear una nueva.