API externe
L'intégration de TARGPatrol à d'autres systèmes peut étendre considérablement les fonctionnalités de votre organisation et améliorer son efficacité. Ce guide vous montrera comment configurer l'intégration à l’aide de l’API externe de TARGPatrol.
Obtention d'une clé API
Accédez à l'application Web https://app.targpatrol.com/ et connectez-vous avec votre compte.
Accédez au "Gestion" -> "API externe" (cette section ne sera disponible que pour les utilisateurs ayant le rôle Propriétaire).
Cliquez sur le "Ajouter un jeton" bouton.
Puis cliquez "Enregistrer", et le jeton apparaîtra dans le tableau.
Ensuite, cliquez sur l'icône de copie du jeton.
Documentation et tests API
Ouvrez la documentation API à l'adresse https://api.targpatrol.com.
Passez en revue les points de terminaison disponibles et leurs capacités. Par exemple, vous pouvez trouver des points de terminaison pour créer des tâches, gérer des utilisateurs, etc.
Utilisez les fonctionnalités de test directement dans la documentation ou utilisez des outils tiers comme Postman pour vous assurer que votre clé API fonctionne correctement.
Données utilisateur
Les demandes et réponses des utilisateurs utilisent les paramètres régionaux pour définir la langue et le formatage régional. Lors de la création d'un utilisateur, indiquez le prénom, le nom, les paramètres régionaux et au moins un emplacement. Les données utilisateur peuvent également inclure externalId et gpsTracking. Utilisez l'une des valeurs de paramètres régionaux répertoriées dans la référence API.
Groupes d'étapes de tâche
Les demandes de tâches et les réponses prennent en charge les stepGroups. Chaque groupe a un ID, un nom, une description facultative, une couleur, un ordre et un paramètre ColombodByDefault. Une étape de tâche référence son groupe via stepGroupId, tandis que l'ordre des étapes reste global dans l'ensemble de la tâche.
Reportez-vous aux schémas et exemples API 1.1 pour connaître l'ensemble complet des champs obligatoires, les valeurs prises en charge et les formats de demande.
Lire l’historique des modifications via l’API
L’API externe propose des routes d’historique en lecture seule avec pagination pour les tâches planifiées, incidents, anciens Issues, utilisateurs, sites et points. Elles sont distinctes des anciennes routes /history renvoyant des instantanés de collections. Les réponses utilisent data et meta, avec une limite par défaut de 25 et un maximum de 100. Consultez la documentation de l’API pour les routes et paramètres exacts. Les exigences habituelles de forfait et de jeton restent applicables : la disponibilité de l’historique web avec tous les forfaits ne rend pas l’accès à l’API gratuit.
Documentation de l’API TARGPatrol
Conclusion
L'intégration de TARGPatrol à d'autres systèmes à l’aide de l’API externe vous permet d'automatiser de nombreux processus et d'assurer une gestion des tâches plus efficace. Suivez ce guide pour configurer l'intégration et tirer parti de tous les avantages qu'elle offre. N'oubliez pas de consulter régulièrement la documentation et les mises à jour de l’API pour obtenir les informations les plus récentes.