Referencia de la API
Referencia de la API
Operaciones de lectura verificadas de la API de la plataforma GPS, agrupadas por tema, con parámetros, respuestas y ejemplos en cuatro lenguajes.
Estado: Verificado · Revisada el 5 de octubre de 2026
Qué se verificó y cómo: Generada a partir del OpenAPI público, que se verificó contra producción por lectura del código y diff. Cada operación declara su propio estado.
La referencia se genera desde el OpenAPI público, que solo contiene operaciones de lectura verificadas. Antes de empezar, lee Autenticación y Convenciones.
Todas las operaciones se llaman con GET, salvo el inicio de sesión, que usa POST, y se autentican con la cabecera user-api-hash.
Grupos #
- DispositivosLista tus vehículos con su última posición y estado, y consulta solo los que cambiaron desde un instante. Parámetros, respuestas y ejemplos. Verificado
- Historial y rutasRecorrido de un vehículo por tramos de conducción y parada, y posiciones GPS crudas paginadas. Rango máximo, zona horaria y ejemplos. Verificado
- Eventos y alertasReglas de alerta, eventos que dispararon y conteo por tipo. Paginación por cursor o por página, filtros y zona horaria. Verificado
- GeocercasConsulta tus geocercas y rutas planificadas, y averigua qué geocercas contienen un punto o la posición actual de un vehículo. Parcial
- ReportesCatálogo de tipos de reporte de tu cuenta y plantillas guardadas. La generación de reportes no está documentada. Verificado
- UsuarioDatos y permisos del usuario de la API, sus conductores y el historial de comandos enviados a los equipos. Verificado
- WebhooksEstado de los webhooks en la API: no hay documentación verificada. Qué hacer mientras tanto para recibir eventos con la API de lectura. Pendiente
Qué hay en cada grupo #
- Dispositivos:
get_devicesyget_devices_latest. - Historial y rutas:
get_historyyget_history_messages. - Eventos y alertas:
get_events,get_alertsyget_alerts_summary. - Geocercas:
get_geofences,point_in_geofences,devices_in_geofencesyget_routes. - Reportes:
get_reportsyget_reports_types. - Usuario:
get_user_data,get_user_driversysent_commands. - Autenticación:
login, en la página de Autenticación.
Qué no incluye esta referencia #
No se documentan operaciones de escritura, de administración de clientes ni de la aplicación móvil de administración. Tampoco hay webhooks documentados: mira Webhooks. El estado de cada operación está en Estado de la documentación.