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 y, opcionalmente, consultar por idsuscrip cuando esa modalidad se encuentre habilitada para el token.
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 integración posee un token único vinculado a los permisos habilitados para consultar por idequipo y, si corresponde, también por idsuscrip. 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 | Condicional | Identificador numérico único del dispositivo QBIT. Se utiliza cuando no se envía idsuscrip. |
idsuscrip |
Entero | Condicional | Permite consultar los últimos registros de los equipos asociados a una suscripción, solo si esa consulta por suscripción está habilitada para el token. |
Debe enviarse idequipo o idsuscrip. Si se envían ambos parámetros, la API prioriza idsuscrip.
Endpoint
| Método HTTP | GET |
| Frecuencia máxima | 5 consultas por minuto |
| Formato de respuesta | JSON |
| Zona horaria | America/Argentina/Buenos_Aires |
| Seguridad | Token con permisos por equipo o por suscripción habilitada |
Consulta opcional por suscripción: GET https://services.bitronic.com.ar/api/sensores?idsuscrip=1234. Si el token no corresponde a esa suscripción o el acceso no está habilitado, la API responde con 401 o 403 según corresponda.
Respuesta esperada en formato JSON:
Cuando la consulta se realiza por idsuscrip, la respuesta devuelve el identificador de la suscripción, la cantidad de registros obtenidos y el arreglo records con el último registro disponible de cada equipo asociado.
Campos de respuesta
En consultas por idequipo, la respuesta incluye record, que contiene los siguientes campos:
| Campo | Tipo | Unidad | Descripción |
|---|---|---|---|
idequipo | string | – | ID del sensor |
datatime | string | Fecha | Fecha del registro |
data | string/array | Depende la variable | Valores medidos |
Respuesta cuando se consulta por idsuscrip
| Campo | Tipo | Unidad | Descripción |
|---|---|---|---|
idsuscrip | string | – | Identificador de la suscripción consultada. |
count | integer | – | Cantidad de registros devueltos en records. |
records | array | – | Listado con el último registro disponible de cada equipo asociado a la suscripción. |
Cada elemento de records mantiene la estructura habitual del registro del sensor y puede incluir campos como idequipo, datatime y data.
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 o idsuscrip es inválido, no numérico o falta un identificador válido para la consulta. |
| 401 | Unauthorized | El token es inválido o no corresponde al idequipo o idsuscrip solicitado. |
| 403 | Forbidden | El acceso para este idequipo o idsuscrip ha sido deshabilitado. |
| 404 | Not Found | El idequipo o idsuscrip solicitado 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.