API de lectura de Data Collections
La Data Collections API (data-collections-api) expone endpoints de lectura curados (solo por alias) para Data Collections publicadas.
Encabezados de autenticación
Envía ambos encabezados en cada petición:
X-API-Key: ID de la llave API de colecciónX-API-Secret: Secreto de la llave API de colección
Las llaves están acotadas estrictamente a una colección ({public_id}). Para llaves de compartición (share keys), la colección debe estar Active, el share activo con can_use_api habilitado y las consultas de snapshot/latest requieren permisos de streaming o ventana configurados por el propietario.
Endpoints
| Método y ruta | Descripción |
|---|---|
GET /api/v1/collections/{public_id} | Devuelve metadatos de la colección y el catálogo curado de tags con alias y unidades. |
GET /api/v1/collections/{public_id}/tags?limit=100&offset=0 | Metadatos paginados ordenados por sort_order (limit 1–1000). |
GET /api/v1/collections/{public_id}/snapshot | Último valor (ok, no_data, o error), marca de tiempo y calidad para cada tag de la colección. |
GET /api/v1/collections/{public_id}/tags/{tag_public_id}/latest | Última lectura para un UUID de tag dentro de la colección (tag_public_id). |
Códigos HTTP frecuentes
| Estado | Significado |
|---|---|
200 OK | Petición exitosa; la respuesta incluye timestamp en UTC. |
401 Unauthorized | Llave o secreto faltante, inválido o expirado. |
403 Forbidden | La llave pertenece a otra colección, la colección está Paused (para share keys) o falta permiso de ventana. |
404 Not Found | No existe el UUID de colección o de tag. |
410 Gone | La colección está Archived (todas las llaves revocadas definitivamente). |
422 Unprocessable Entity | UUID o parámetro de paginación inválido. |
503 / 504 | Dependencia de autenticación/origen no disponible o tiempo de espera excedido. |