Autenticación y claves API

Autentica las solicitudes a la API de Kilo IoT con claves con ámbito — encabezados X-API-Key y X-Organization-Id, claves por integración.

Cada solicitud de API — REST o gRPC — se autentica con una clave de API con ámbito. Cree, delimite, rote y revoque claves en Configuración → Claves de API; esta página explica cómo se autentican las solicitudes.

Cómo se autentican las solicitudes

• X-API-Key — su clave de API (formato kilo_<key>). Envíela en cada solicitud.

• X-Organization-Id — la organización en la que actúa la solicitud. Debe coincidir con la organización en la que se creó la clave. Algunas operaciones también aceptan la organización como un organizationId parámetro de consulta en lugar del encabezado.

Todas las solicitudes se realizan sobre TLS.

Ámbitos

Las claves tienen ámbito. La mayoría de las áreas tienen Leer y Escribir ámbitos separados; algunas — como la telemetría y los datos de suscripción — son de solo lectura. Una clave concede solo lo que seleccione cuando la cree, así que conceda solo los ámbitos que necesita la integración. Cada extremo en la referencia de la API enumera el ámbito que requiere.

El Crear clave de API El cuadro de diálogo solicita un nombre, una fecha de expiración opcional y los propios ámbitos; cada ámbito comienza sin marcar, así que una clave no concede nada hasta que usted lo indique.

Manejo seguro de las claves

• El valor completo de la clave se muestra una vez al crearla; después solo se ve un prefijo corto. Guárdelo inmediatamente en un gestor de secretos o una bóveda.

• Use una clave separada por integración para que una pueda revocarse sin interrumpir las demás.

• Rote o revoque una clave inmediatamente si puede haberse expuesto; la rotación es la única vía de recuperación para una clave perdida.

• Nunca incruste una clave en código del lado del cliente ni la confirme en el control de código fuente.