API externa

Integrar TARGPatrol con otros sistemas puede ampliar significativamente la funcionalidad de su organización y mejorar la eficiencia. Esta guía muestra cómo configurar la integración mediante la API externa de TARGPatrol.

Obtener una clave API

  1. Vaya a la aplicación web https://app.targpatrol.com/ e inicie sesión con su cuenta.

    Obtaining an API Key
  2. Vaya a la sección "Gestión" -> "API externa". Esta sección solo estará disponible para usuarios con rol de propietario.

  3. Haga clic en el botón "Añadir token".

    Obtaining an API Key
  4. Luego haga clic en "Guardar" y el token aparecerá en la tabla.

  5. Después, haga clic en el icono para copiar el token.

Documentación y pruebas de la API

  1. Abra la documentación de la API en https://api.targpatrol.com.

  2. Revise los endpoints disponibles y sus capacidades. Por ejemplo, encontrará endpoints para crear tareas, gestionar usuarios y más.

  3. Use las funciones de prueba directamente en la documentación o herramientas de terceros como Postman para comprobar que su clave API funciona correctamente.

API Documentation and Testing

Datos del usuario

Las solicitudes y respuestas de usuarios utilizan locale para definir el idioma y el formato regional. Al crear un usuario, indique el nombre, los apellidos, la configuración regional y al menos una ubicación. Los datos del usuario también pueden incluir externalId y gpsTracking. Use uno de los valores de locale indicados en la referencia de la API.

Grupos de pasos de una tarea

Las solicitudes y respuestas de tareas admiten stepGroups. Cada grupo tiene un ID, un nombre, una descripción opcional, un color, un orden y la opción collapsedByDefault. Un paso hace referencia a su grupo mediante stepGroupId, mientras que el orden de los pasos sigue siendo global para toda la tarea.

Consulte los esquemas y ejemplos de la API 1.1 para conocer todos los campos obligatorios, los valores admitidos y los formatos de solicitud.

Conclusión

Integrar TARGPatrol con otros sistemas mediante la API externa permite automatizar numerosos procesos y lograr una gestión de tareas más eficiente. Siga esta guía para configurar la integración y aprovechar sus beneficios. Recuerde revisar periódicamente la documentación y las actualizaciones de la API para disponer de la información más reciente.