API REST pública

API REST pública de Kilo IoT Server — superficie principal de integración sobre HTTPS/JSON con X-API-Key y X-Organization-Id.

La API REST es la forma principal de integrar Kilo IoT Server con sistemas externos a través de HTTPS estándar. Cualquier lenguaje o herramienta que pueda hacer una solicitud HTTP autenticada puede usarla — servicios de backend, canalizaciones de datos, trabajos de informes y herramientas operativas.

Usa Referencia de la API para la lista completa de endpoints, parámetros de solicitud, esquemas de respuesta y alcances requeridos.

Endpoint base y autenticación

Las solicitudes van al endpoint de producción seguro y llevan dos encabezados:

• X-API-Key — una clave con ámbito creada en Configuración → Claves de API.

• X-Organization-Id — la organización en la que opera la solicitud; debe coincidir con la organización de la clave. Algunas operaciones también aceptan la organización como un organizationId parámetro de consulta en lugar del encabezado.

Todo el tráfico va sobre TLS. Trata la clave como una credencial — consulta Autenticación y claves de API.

Lo que puede hacer la API

REST es la superficie amplia y principal. Sujeto a los alcances concedidos a la clave, las integraciones pueden funcionar en toda la plataforma — por ejemplo: leer el perfil de la cuenta/usuario; listar y administrar dispositivos y su configuración física del dispositivo (el ID del dispositivo cliente, la conexión a la que se enlaza y la configuración específica de la conexión), sus sensores y asignaciones de sensores, y plantillas de sensores; leer el historial de sensores y valores de última detección valores; leer definiciones de conectores y administrar conexiones; leer y administrar paneles y widgets; leer datos de organización, membresía y suscripción; leer y administrar definiciones de reglas de automatización, junto con sus versiones y compilaciones; y definir y enviar comandos para dispositivos para controlar el hardware.

Para integraciones tipadas de servicio a servicio o locales, consulte API gRPC.

Flujo de trabajo

1. Crea una clave con ámbito en Configuración → Claves de API y guárdala de forma segura.

2. Encuentra la operación que necesitas en la referencia de la API.

3. Llámala con X-API-Key y X-Organization-Id.

4. Gestiona los códigos de estado HTTP estándar y las respuestas JSON.

Una llamada autenticada mínima está en Ejemplos.

Ver también

• API gRPC — cuando los clientes tipados o las llamadas de servicio a servicio encajen mejor.

• Autenticación y claves de API

• Claves API — crea y administra claves.