Externe API
Die Integration von TARGPatrol mit anderen Systemen kann den Funktionsumfang Ihrer Organisation deutlich erweitern und die Effizienz verbessern. Diese Anleitung zeigt, wie Sie die Integration über die externe API von TARGPatrol einrichten.
API-Schlüssel erhalten
Öffnen Sie die Webanwendung https://app.targpatrol.com/ und melden Sie sich mit Ihrem Konto an.
Navigieren Sie zum Bereich "Verwaltung" -> "Externe API" (dieser Bereich ist nur für Benutzer mit der Rolle Owner verfügbar).
Klicken Sie auf die Schaltfläche "Token hinzufügen".
Klicken Sie anschließend auf "Speichern", und der Token erscheint in der Tabelle.
Klicken Sie danach auf das Symbol zum Kopieren des Tokens.
API-Dokumentation und Tests
Öffnen Sie die API-Dokumentation unter https://api.targpatrol.com.
Prüfen Sie die verfügbaren Endpunkte und ihre Funktionen. Sie finden dort zum Beispiel Endpunkte zum Erstellen von Aufgaben, Verwalten von Benutzern und vieles mehr.
Nutzen Sie die Testfunktionen direkt in der Dokumentation oder verwenden Sie Drittanbieter-Tools wie Postman, um sicherzustellen, dass Ihr API-Schlüssel korrekt funktioniert.
Benutzerdaten
Benutzeranfragen und -antworten verwenden locale, um Sprache und regionale Formatierung festzulegen. Geben Sie beim Erstellen eines Benutzers Vorname, Nachname, Locale und mindestens einen Standort an. Benutzerdaten können außerdem externalId und gpsTracking enthalten. Verwenden Sie einen der in der API-Referenz aufgeführten Locale-Werte.
Gruppen von Aufgabenschritten
Aufgabenanfragen und -antworten unterstützen stepGroups. Jede Gruppe besitzt eine ID, einen Namen, eine optionale Beschreibung, eine Farbe, eine Reihenfolge und die Einstellung collapsedByDefault. Ein Aufgabenschritt referenziert seine Gruppe über stepGroupId, während die Schrittreihenfolge global für die gesamte Aufgabe gilt.
Die vollständige Liste der Pflichtfelder, unterstützten Werte und Anfrageformate finden Sie in den Schemas und Beispielen der API 1.1.
Fazit
Die Integration von TARGPatrol mit anderen Systemen über die externe API ermöglicht es, zahlreiche Prozesse zu automatisieren und Aufgaben effizienter zu verwalten. Folgen Sie dieser Anleitung, um die Integration einzurichten und alle Vorteile zu nutzen. Prüfen Sie regelmäßig die Dokumentation und API-Updates, um stets mit den aktuellen Informationen zu arbeiten.