Ir al contenido

API pública

La API pública permite que el backend de tu organización consulte datos de AlertIA y reciba avisos firmados por HTTPS, sin usar el JWT de un usuario del dashboard.

Todas las rutas viven bajo el prefijo /public/v1. La base URL es la del Core API de tu entorno (por ejemplo https://api.ejemplo.com).

Tema Descripción
Autenticación OAuth client_credentials, token Bearer, scopes y rate limits
Recursos Dispositivos, carpetas y tableros NOC
Telemetría Última lectura e histórico (pull, máx. 7 días)
Webhooks Alertas y digest periódico de flota (HMAC)
  1. En el dashboard: Integraciones → crear una aplicación de integración (elegí los permisos / scopes).
  2. Guardá el client_secret (se muestra una sola vez; si se pierde, rotá el secreto).
  3. Pedí un token: POST /public/v1/oauth/token.
  4. Llamá a los GET con Authorization: Bearer <access_token>.
  5. Opcional: configurá uno o más webhooks https para alertas y, si querés, un digest de flota.
Método Ruta Scope
POST /public/v1/oauth/token — (público; rate limit propio)
GET /public/v1/devices devices.read
GET /public/v1/folders folders.read
GET /public/v1/boards boards.read
GET /public/v1/boards/{boardId} boards.read
GET /public/v1/devices/{deviceId}/telemetry/latest telemetry.read
GET /public/v1/devices/{deviceId}/telemetry/history telemetry.read

Los webhooks no se administran por esta API en v1: se configuran en el dashboard (Integraciones). AlertIA hace POST a tu URL.

El token OAuth queda atado a una organización (la de la app de integración). Solo vas a ver datos de esa organización; no hace falta enviar un customerId en la URL de lectura.

Código Significado
400 Parámetros inválidos (p. ej. rango de fechas)
401 Token ausente, expirado o no válido para esta API
403 Scope insuficiente para el recurso
404 Recurso inexistente o de otra organización
429 Rate limit; reintentá respetando Retry-After si viene
503 Emisión de tokens no disponible en el entorno

Esta API es para backends de clientes que consumen datos. El alta y telemetría que publica un dispositivo / agente está documentada en Protocolo (MQTT, REST de dispositivo, etc.).