Avanzza Telemetry API REST (1.0.0)
Esta API REST pretende ser una herramienta que permita a los ingenieros encargados de la integración conocer la estructura de nuestra api pública.
Consideraciones:
- Se recomienda copiar el API_TOKEN en algún lugar seguro para su posterior uso.
- Cada API_TOKEN tiene un periodo de caducidad por lo que deberá ser renovado oportunamente.
En esta sección se trata de describir los recursos que ofrece el API para el manejo de eventos realtime.
Crear un nuevo evento
Esta operación permite crear un nuevo evento en el sistema.
Authorizations:
Request Body schema: application/json
Objeto de evento
| event_type required | string Enum: "sleepiness_patterns" "distraction" "driver" "detection" "driving" "security" |
| vehicle_code required | string |
| driver_code | string |
| lat required | number |
| lng required | number |
| device_timestamp required | string |
| event_data | Array of strings |
| description required | string |
Array of objects (evidence) non-empty |
Responses
Request samples
- Payload
{- "event_type": "sleepiness_patterns",
- "vehicle_code": "V001",
- "driver_code": "LIC001",
- "lat": 77.00981,
- "lng": 12.99871,
- "device_timestamp": "1724446394",
- "event_data": [
- {
- "item1": "value1"
}, - {
- "item2": "value2"
}
], - "description": "Example description",
- "evidences": [
- {
- "file": "string"
}
]
}Response samples
- 201
- 401
- 422
{- "event": "4cc2ad15-f308-4bdc-8132-79da9439bdad",
- "evidences": [
- {
- "uuid": "4cc2ad15-f308-4bdc-8132-79da9439bdad",
- "status": "pending",
- "message": "Evidencia subida correctamente"
}
]
}En esta sección se trata de describir los recursos que ofrece el API para el manejo de eventos offline.
Crear nuevos eventos de manera offline
Esta operación permite crear nuevos eventos en el sistema.
Authorizations:
Request Body schema: application/json
Objeto de evento
Array of objects (event) |
Responses
Request samples
- Payload
{- "events": [
- {
- "event_type": "sleepiness_patterns",
- "vehicle_code": "V001",
- "driver_code": "LIC001",
- "lat": 77.00981,
- "lng": 12.99871,
- "device_timestamp": "1724446394",
- "event_data": [
- {
- "item1": "value1"
}, - {
- "item2": "value2"
}
], - "description": "Example description",
- "evidences": [
- {
- "file": "string"
}
]
}
]
}Response samples
- 201
- 401
- 422
[- {
- "uuid": "4cc2ad15-f308-4bdc-8132-79da9439bdad",
- "evidences": [
- {
- "uuid": "4cc2ad15-f308-4bdc-8132-79da9439bdad",
- "status": "pending",
- "message": "Evidencia subida correctamente"
}
]
}
]En esta sección se trata de describir los recursos que ofrece el API para el manejo de verificación de estado de evidencias.
Verificar carga de evidencias de un evento
Esta operación permite verificar el estado de carga de las evidencias de un evento en el sistema.
Authorizations:
path Parameters
| uuid required | string Identificador del evento |
Responses
Response samples
- 200
- 401
- 422
[- {
- "uuid": "4cc2ad15-f308-4bdc-8132-79da9439bdad",
- "status": "pending",
- "message": "Evidencia subida correctamente"
}
]En esta sección se trata de describir los recursos que ofrece el API para el manejo de evidencias.
Carga de una nueva evidencia para un evento
Esta operación permite crear nuevas evidencias para un evento.
Authorizations:
path Parameters
| uuid required | string Identificador del evento |
Request Body schema: multipart/form-data
Evidencia de tipo cadena o binario
| file | string <binary> |
Responses
Response samples
- 201
- 401
- 422
{- "uuid": "4cc2ad15-f308-4bdc-8132-79da9439bdad",
- "status": "pending",
- "message": "Evidencia subida correctamente"
}