FAQ: Métodos de la API de Socios

5.7.2024 | Veranika Patachyts

¿Qué es la API de Socios?


La API de Socios de GPS-Trace es una herramienta poderosa que permite a las empresas integrar capacidades avanzadas de seguimiento GPS en sus sistemas existentes. Ofrece una variedad de métodos para crear y gestionar cuentas de usuario y planes de clientes, configurar unidades y generar informes personalizados e incluso descargar estadísticas.


¿Cómo autentico mis solicitudes a la API de Socios?


La API de Socios utiliza autenticación de token API para garantizar un acceso seguro. Necesitas generar un token API desde tu cuenta, que luego usarás para autenticar todas tus solicitudes.


¿Cuáles son las características clave de la API de Socios?


Las características clave de la API de GPS-Trace incluyen:

  • Gestión de cuentas
  • Gestión de empresas
  • Gestión de planes de clientes
  • Gestión de unidades
  • Gestión de usuarios
  • Gestión de facturación

Plataforma de socios


¿Cómo puedo gestionar usuarios con la API de Socios?


La API de Socios proporciona endpoints para el registro y gestión de usuarios. Puedes crear nuevas cuentas de usuario, actualizar información de usuarios y gestionar planes de clientes y conjuntos de módulos y permisos para garantizar una base de usuarios segura y organizada.


¿Cómo funciona la gestión de cuentas?


La subsección CRUD de cuentas cubre métodos relacionados con operaciones CRUD (Crear, Leer, Actualizar, Eliminar) para cuentas, que incluyen:

  • Crear cuentas: Métodos para crear nuevas cuentas en el sistema.
  • Eliminar cuentas: Métodos para eliminar cuentas del sistema.
  • Actualizar cuentas: Métodos para actualizar información de cuentas existentes.
  • Recuperar información de cuentas: Métodos para obtener detalles de cuentas específicas.

Al crear una cuenta de cliente, se asigna una aplicación a la cuenta, otorgando acceso al cliente. Esto se implementa a través de una solicitud, siendo uno de los campos obligatorios "reg_apps". Los IDs de las aplicaciones incluyen:

  • Ruhavik - 5a5ca87f-7cbe-4540-ab5d-77bf4bf69884
  • Petovik - 962e19f0-6b4a-4f81-a3fe-4b657689b6f9
  • Forguard - b901da51-ce00-4af2-b978-8d0fca8ae1ea

Las entidades de usuario se crean simultáneamente con la creación de una cuenta de cliente y están inicialmente inactivas. 

Para activar la cuenta:

  • el socio envía un enlace de activación especial a su cliente.
  • Al hacer clic en el enlace de activación, el cliente ingresa su dirección de correo electrónico única (para asociarla con la cuenta) y una contraseña.
  • El cliente luego recibe un correo electrónico de confirmación de registro en la dirección proporcionada. Al seguir el enlace en el correo electrónico, el cliente completa el proceso de registro ingresando la información solicitada en el formulario, que podría incluir contraseña, clave de inicio de sesión, etc.

Como resultado, creas un nuevo usuario con la ayuda de nuestra API en solo unos pocos clics.


¿Es una API de Socios o una API para monitoreo GPS?


Definitivamente es una API de socios basada en la funcionalidad de nuestro Panel de Socios. No puedes monitorear tu flota a través de ella. El objetivo principal es manejar y personalizar cuentas de clientes y unidades, establecer tarifas, gestionar análisis e historial. Usando nuestra API, puedes integrar nuestra plataforma de socios con tu sistema CRM y de facturación.

Documentación de la API de Socios GPS


¿Cómo puede beneficiar a mi negocio?


La API de Socios simplifica varios aspectos operativos, como la gestión de vehículos, el seguimiento de activos y la generación de informes de datos. Al automatizar estos procesos, las empresas pueden reducir el esfuerzo manual y aumentar la rentabilidad con facilidad.


¿Puedo acceder a datos de seguimiento históricos usando la API de Socios?


Sí, la API de Socios de GPS-Trace permite el acceso a datos de seguimiento históricos.
Estos datos son valiosos para analizar el rendimiento, investigar incidentes y optimizar operaciones futuras. Por ejemplo, puedes usar el GET /partner/units/{id}/messages(Obtener Mensajes de la Unidad) para recuperar mensajes de un dispositivo (unidad) en Forguard. El número máximo de mensajes que se pueden recuperar es 10,000, y también puedes especificar el número de mensajes recientes que deseas obtener.

Ejemplo de solicitud para obtener los últimos 10 mensajes:

curl -X 'GET' \
  'https://api.gps-trace.com/partner/units/<unit id>/messages?count=10' \
  -H 'accept: application/' \
  -H 'X-AccessToken: <your token>'

Los campos en la respuesta dependerán de los parámetros enviados por el rastreador.


¿Cómo puede informes personalizados ayudar a mi negocio?


Los informes personalizados te permiten generar informes detallados basados en tus necesidades específicas.
Estos informes pueden incluir datos sobre el uso y la eficiencia de los vehículos, proporcionando información valiosa para la toma de decisiones y la mejora de estrategias empresariales. Por ejemplo, para obtener los últimos datos de telemetría de la unidad, debes usar el GET /partner/units/{id}/telemetry” (Obtener Datos de Telemetría).

Ejemplo de solicitud:

curl -X 'GET' \
  'https://api.gps-trace.com/partner/units/<unit id>/telemetry' \
  -H 'accept: application/' \
  -H 'X-AccessToken: <your token>'

Como resultado, descargarás un informe con el último mensaje de telemetría de cada dispositivo que especificaste.


¿Cómo puedo empezar con la API de Socios?


Para empezar con la API de Socios, puedes completar el formulario en nuestro sitio web o escribirnos a business@gps-trace.com