API externa
Conecte sus sistemas con una organización mediante la API externa de TARGPatrol. Esta guía explica acceso, autenticación e integración segura. Los campos y ejemplos de cada operación están en la referencia de la API.
Disponibilidad y claves API
La API externa está disponible en Base y Enterprise, no en Free. El Propietario crea y administra los tokens en la web. Cada clave identifica una organización; no es una contraseña personal ni un ID/PIN móvil.
Inicie sesión en la web y abra la organización correcta como Propietario.
Abra Gestión → API externa y seleccione Añadir token.
Indique un nombre claro para la integración, guarde el token y copie la clave.
Guárdela en un almacén de secretos del servidor. Use tokens separados cuando sea posible y revoque los que ya no necesite.
Autenticar solicitudes
Envíe solicitudes HTTPS al host de la referencia con la ruta base /api/v1. Incluya la clave en la cabecera x-api-key. Iniciar sesión en la web no autentica una solicitud externa. No coloque claves en URLs, código del navegador, capturas, repositorios públicos ni registros.
1x-api-key: <YOUR_API_KEY>Usar la referencia y probar con seguridad
Abra la referencia y revise método, ruta, campos obligatorios y esquema de respuesta de la operación.
Empiece con una solicitud de solo lectura y compruebe la organización de los resultados. Las pruebas interactivas pueden actuar sobre datos reales.
Siga la paginación, filtros y ordenación de cada operación; no suponga que todos los valores predeterminados coinciden.
Antes de escribir, compruebe la semántica de POST, PUT o PATCH y los valores omitidos, null o vacíos. Pruebe cambios primero en una organización de prueba.
Gestione los fallos de red y servidor. No repita solicitudes de creación a ciegas ni registre claves o datos personales.
Referencia API y explorador interactivo
Resolver problemas de acceso
Con 401, revise x-api-key y que el token siga existiendo. Con 403, revise el plan y los requisitos de la operación. Con 404, compruebe URL, identificador y organización; con 400, formato y validación. Sustituya una clave expuesta y actualice todas las integraciones que la utilicen.
Novedades de la referencia API
1.1
La referencia 1.1 hizo obligatorio lastName al crear usuarios y corrigió el nombre del campo de asignación de ubicaciones a locationIds. Consulte el esquema de usuario actual al preparar solicitudes.
1.2
La referencia 1.2 añadió URL de descarga firmadas y temporales para los archivos adjuntos de Issues del módulo antiguo, incluidas URL de miniaturas cuando están disponibles. Los enlaces deben utilizarse antes de que caduquen.
1.3
La referencia 1.3 añadió consulta y creación de comentarios para tareas, incidentes e Issues del módulo antiguo, además de edición y eliminación de comentarios creados mediante la API. Los archivos adjuntos existentes se pueden consultar y descargar; esta API no permite subir archivos adjuntos ni editar comentarios creados por usuarios de la aplicación.
1.4
La referencia 1.4 incorporó metadatos y validación de teléfonos internacionales para usuarios. Consulte los esquemas actuales para las reglas exactas de solicitudes y actualizaciones.
1.5
La referencia 1.5 añadió historial de cambios por registro, de solo lectura. Las actualizaciones posteriores documentan historiales de usuarios, ubicaciones y puntos, además del orden de puntos y operaciones para reordenar/mover. Consulte la referencia actual para compatibilidad y operaciones disponibles.
1.6
La referencia 1.6 documenta tareas recurrentes basadas en calendario con una zona horaria explícita y una plantilla local de inicio y fin. Consulta el esquema actual antes de crear o editar una serie.
1.7
La referencia 1.7 añade la consulta de eventos de geocerca y campos relacionados de ubicaciones y usuarios, y alinea las operaciones de etiquetas admitidas. La autenticación y /api/v1 no cambian. Consulta esquemas, permisos y validación en la referencia actual; esta actualización no incluye webhooks de geocercas.
Son versiones de la referencia/esquema, no prefijos URL nuevos: la ruta base sigue siendo /api/v1. Este resumen no sustituye un registro completo de cambios. Los webhooks se configuran aparte para actualizaciones basadas en eventos.