API REST
Esta API REST permite integrar sensores QBIT a otros sistemas ya existentes, consultar registros recientes enviados por
dispositivos que se identifican por el idequipo.
La API REST está diseñada para ser utilizada por aplicaciones externas que necesiten interactuar con los datos de los sensores QBIT.
Proporciona una interfaz sencilla y eficiente para acceder a la información de los sensores, permitiendo a los desarrolladores
integrar fácilmente los datos en sus propias aplicaciones o sistemas.
Autenticación
Se utiliza autenticación mediante Bearer Token. Cada dispositivo posee un token único vinculado a su identificador (idequipo). Este token debe ser solicitado a soporte y el equipo debe tener plan Avanzado o superior.
| Encabezado HTTP |
Formato |
Ejemplo |
Authorization |
Bearer <token> |
Bearer abcd1234efgh5678 |
Parámetros de consulta
| Nombre |
Tipo |
Obligatorio |
Descripción |
idequipo |
Entero |
Sí |
Identificador numérico único del dispositivo QBIT. |
Endpoint
| Método HTTP | GET |
| Frecuencia máxima | 5 consultas por minuto |
| Formato de respuesta | JSON |
| Zona horaria | America/Argentina/Buenos_Aires |
| Seguridad | Token individual por equipo |
Respuesta esperada en formato JSON:
Campos de respuesta
| Campo |
Tipo |
Unidad |
Descripción |
idequipo | string | – | ID del sensor |
datatime | string | Fecha | Fecha del registro |
data | string/array | Depende la variable | Valores medidos |
Códigos de estado HTTP
| Código |
Significado |
Descripción |
| 200 |
OK |
Consulta exitosa. Se devuelven los registros. |
| 204 |
No Content |
No hay registros disponibles en el rango configurado. |
| 400 |
Bad Request |
El parámetro idequipo es inválido o no numérico. |
| 401 |
Unauthorized |
El token es inválido o no corresponde al equipo solicitado. |
| 403 |
Forbidden |
El acceso para este equipo ha sido deshabilitado. |
| 404 |
Not Found |
El identificador de equipo no está registrado. |
| 429 |
Too Many Requests |
Se superó el límite de consultas por minuto. |
Matriz de errores y acciones recomendadas
| Código | Posible causa | Acción sugerida |
|---|
| 401 / 403 | Token incorrecto o vencido | Revisar credenciales y permisos |
| 429 | Exceso de consultas | Implementar backoff exponencial |
| 500 | Error interno | Contactar soporte técnico con logs |
Consulta opcional por fecha
Para ciertos entornos habilitados, se permite filtrar por fecha y hora (previa autorización).
| Parámetro |
Tipo |
Formato |
Descripción |
desde |
string |
YYYY-MM-DD HH:MM:SS |
Desde Fecha/hora |
hasta |
string |
YYYY-MM-DD HH:MM:SS |
Hasta Fecha/hora |
Buenas prácticas de integración
- Evitar consultas continuas no necesarias (respetar la frecuencia).
- Registrar y auditar errores por equipo.
- Implementar monitoreo por latencia y códigos HTTP.
- Proteger los tokens en entornos seguros.
La API REST utiliza autenticación basada en tokens para garantizar la seguridad de las solicitudes. Cada solicitud debe incluir un
token de autenticación válido en el encabezado de la solicitud. Este token se entrega al desarrollador al momento de la
integración y debe ser tratado como información confidencial.
Consideraciones de rendimiento
- Evitar consultas con frecuencia mayor a 1 por minuto.
- No está optimizada para volúmenes históricos extensos.
- La API escala horizontalmente bajo demanda.
