¿Qué es la API de la plataforma GPS-Trace?
La Platform API es una interfaz de software para usuarios registrados de GPS-Trace Console. Permite que sistemas externos, como CRM, facturación o herramientas de informes, soliciten datos de GPS-Trace y realicen determinadas operaciones de Console.
La API incluye métodos para trabajar con usuarios, planes de cliente, unidades, datos de facturación, estadísticas e informes.
¿Cómo autentico las solicitudes a la API?
Las solicitudes a la API se autentican con un token de API. Un token es una clave de acceso generada en GPS-Trace Console. Debe incluirse en cada solicitud para que la plataforma pueda comprobar qué acciones están permitidas para el usuario.
El token se envía en el encabezado de solicitud X-AccessToken.
¿Qué grupos de métodos de API están disponibles?
La API incluye los siguientes grupos de métodos:
- Métodos de datos de cuenta
- Métodos de datos de la empresa
- Métodos de planes de cliente
- Métodos de unidad
- Métodos de usuario
- Métodos de datos de facturación
- Métodos de estadísticas e informes
¿Cómo puedo trabajar con usuarios a través de la API?
La Platform API ofrece métodos para trabajar con usuarios. Según los permisos disponibles, los usuarios de Console pueden crear registros de usuario, actualizar datos de usuario y asignar planes de cliente, módulos y permisos.
¿Cómo funcionan los métodos de datos de cuenta?
La sección de cuenta incluye métodos para crear, leer, actualizar y eliminar datos de cuenta. A estas acciones se les suele llamar operaciones CRUD.
- Crear una cuenta
- Eliminar una cuenta
- Actualizar datos de la cuenta
- Obtener datos de la cuenta
Cuando se crea una cuenta de cliente, la solicitud puede incluir la aplicación que debe asignarse a la cuenta. Esto se hace mediante el campo reg_apps. Las aplicaciones disponibles dependen del nivel de acceso del usuario y de los términos del acuerdo.
Los registros de usuario se crean junto con la cuenta de cliente y permanecen inactivos hasta que se complete el proceso de activación.
Para activar la cuenta:
- El usuario de Console envía un enlace de activación al cliente.
- El cliente sigue el enlace e introduce una dirección de correo electrónico y una contraseña.
- El cliente confirma el registro mediante el enlace de confirmación recibido por correo.
- Tras la confirmación, la cuenta de usuario pasa a estar activa según la aplicación, el plan y los permisos asignados.
¿Esta API se usa para rastrear vehículos directamente?
La API está pensada para operaciones de GPS-Trace Console y para el intercambio de datos con sistemas externos. No sustituye a la aplicación móvil Forguard ni a otras interfaces de rastreo de GPS-Trace.
Los usuarios de Console pueden usar la API para trabajar con unidades, planes de cliente, estadísticas, historial, sistemas CRM y sistemas de facturación, según su nivel de acceso.
¿Para qué se puede utilizar la API?
La Platform API se puede utilizar para conectar GPS-Trace con CRM, facturación, informes o sistemas internos.
Por ejemplo, los usuarios de Console pueden obtener datos de unidades, trabajar con planes de cliente, exportar estadísticas y reducir acciones manuales repetidas en flujos de trabajo externos.
¿Puedo acceder a datos históricos de rastreo a través de la API?
Sí, la Platform API puede proporcionar acceso a datos históricos de rastreo, según los métodos y permisos disponibles.
Por ejemplo, el método GET /partner/units/{id}/messages recupera mensajes de una unidad. El número máximo de mensajes que se pueden recuperar es 10.000. También puedes especificar cuántos mensajes recientes quieres recibir.
Ejemplo de solicitud para obtener los últimos 10 mensajes:
curl -X 'GET' \
'https://api.gps-trace.com/partner/units//messages?count=10' \
-H 'accept: application/' \
-H 'X-AccessToken: '
Los campos de la respuesta dependen de los parámetros enviados por el dispositivo de rastreo.
¿Cómo puedo obtener datos de telemetría?
Para obtener los datos de telemetría más recientes de una unidad, utiliza el método GET /partner/units/{id}/telemetry. La respuesta contiene el último mensaje de telemetría disponible para la unidad especificada. Los campos exactos dependen de los datos enviados por el dispositivo de rastreo.
Ejemplo de solicitud:
curl -X 'GET' \
'https://api.gps-trace.com/partner/units//telemetry' \
-H 'accept: application/' \
-H 'X-AccessToken: '
¿Cómo puedo empezar a usar la API?
Para solicitar acceso a la API, solo inicia sesión en tu cuenta de Console. Si no la tienes, también puedes registrarte aquí.