Was ist die GPS-Trace Platform API?
Die Platform API ist eine Softwareschnittstelle für registrierte GPS-Trace Console-Benutzer. Sie ermöglicht es externen Systemen, z. B. CRM-, Abrechnungs- oder Reporting-Tools, GPS-Trace-Daten abzufragen und ausgewählte Console-Operationen auszuführen.
Die API umfasst Methoden für die Arbeit mit Benutzern, Client-Plänen, Geräten, Abrechnungsdaten, Statistiken und Berichten.
Wie authentifiziere ich API-Anfragen?
API-Anfragen werden mit einem API-Token authentifiziert. Ein Token ist ein Zugriffsschlüssel, der in GPS-Trace Console generiert wird. Er muss in jeder Anfrage enthalten sein, damit die Plattform prüfen kann, welche Aktionen für den Benutzer erlaubt sind.
Der Token wird im Request-Header X-AccessToken gesendet.
Welche API-Methodengruppen sind verfügbar?
Die API enthält die folgenden Methodengruppen:
- Methoden für Kontodaten
- Methoden für Unternehmensdaten
- Methoden für Client-Pläne
- Geräte-Methoden
- Benutzer-Methoden
- Methoden für Abrechnungsdaten
- Methoden für Statistiken und Berichte
Wie kann ich über die API mit Benutzern arbeiten?
Die Platform API stellt Methoden für die Arbeit mit Benutzern bereit. Abhängig von den verfügbaren Berechtigungen können GPS-Trace Console-Benutzer Benutzereinträge erstellen, Benutzerdaten aktualisieren sowie Client-Pläne, Module und Berechtigungen zuweisen.
Wie funktionieren die Methoden für Kontodaten?
Der Konto-Bereich enthält Methoden zum Erstellen, Lesen, Aktualisieren und Löschen von Kontodaten. Diese Aktionen werden häufig als CRUD-Operationen bezeichnet.
- Ein Konto erstellen
- Ein Konto löschen
- Kontodaten aktualisieren
- Kontodaten abrufen
Wenn ein Client-Konto erstellt wird, kann die Anfrage die Anwendung enthalten, die dem Konto zugewiesen werden soll. Dies erfolgt über das Feld reg_apps. Die verfügbaren Anwendungen hängen vom Zugriffslevel des Benutzers und den Vertragsbedingungen ab.
Benutzereinträge werden zusammen mit dem Client-Konto erstellt und sind inaktiv, bis der Aktivierungsprozess abgeschlossen ist.
So aktivieren Sie das Konto:
- Der GPS-Trace Console-Benutzer sendet einen Aktivierungslink an den Client.
- Der Client folgt dem Link und gibt eine E-Mail-Adresse sowie ein Passwort ein.
- Der Client bestätigt die Registrierung über den Bestätigungslink in der E-Mail.
- Nach der Bestätigung wird das Benutzerkonto gemäß der zugewiesenen Anwendung, dem Plan und den Berechtigungen aktiv.
Wird diese API für die direkte Fahrzeugortung verwendet?
Die API ist für Operationen in GPS-Trace Console und den Datenaustausch mit externen Systemen vorgesehen. Sie ist kein Ersatz für die Forguard-Mobile-App oder andere GPS-Trace-Tracking-Oberflächen.
GPS-Trace Console-Benutzer können die API je nach Zugriffslevel einsetzen, um mit Geräten, Client-Plänen, Statistiken, Verlauf, CRM-Systemen und Abrechnungssystemen zu arbeiten.
Wofür kann die API verwendet werden?
Die Platform API kann verwendet werden, um GPS-Trace mit CRM-, Abrechnungs-, Reporting- oder internen Systemen zu verbinden.
So können GPS-Trace Console-Benutzer beispielsweise Gerätedaten abrufen, mit Client-Plänen arbeiten, Statistiken exportieren und wiederholte manuelle Aktionen in externen Workflows reduzieren.
Kann ich über die API auf historische Tracking-Daten zugreifen?
Ja, die Platform API kann – abhängig von den verfügbaren Methoden und Berechtigungen – Zugriff auf historische Tracking-Daten bereitstellen.
Beispielsweise ruft die Methode GET /partner/units/{id}/messages Nachrichten eines Geräts ab. Die maximale Anzahl abrufbarer Nachrichten beträgt 10.000. Sie können außerdem die Anzahl der neuesten Nachrichten angeben, die Sie erhalten möchten.
Beispielanfrage zum Abrufen der letzten 10 Nachrichten:
curl -X 'GET' \
'https://api.gps-trace.com/partner/units//messages?count=10' \
-H 'accept: application/' \
-H 'X-AccessToken: '
Welche Felder in der Antwort enthalten sind, hängt von den Parametern ab, die vom Tracking-Gerät gesendet werden.
Wie kann ich Telemetriedaten abrufen?
Um die neuesten Telemetriedaten für ein Gerät abzurufen, verwenden Sie die Methode GET /partner/units/{id}/telemetry. Die Antwort enthält die neueste verfügbare Telemetrie-Nachricht für das angegebene Gerät. Welche Felder genau enthalten sind, hängt von den Daten ab, die vom Tracking-Gerät gesendet werden.
Beispielanfrage:
curl -X 'GET' \
'https://api.gps-trace.com/partner/units//telemetry' \
-H 'accept: application/' \
-H 'X-AccessToken: '
Wie kann ich mit der API starten?
Um API-Zugriff anzufordern, melden Sie sich einfach in Ihrem Console-Konto an. Falls Sie noch keines haben, können Sie sich auch hier registrieren.