FAQ: Partner-API-Methoden | Blog | GPS-Trace

FAQ: Partner-API-Methoden

5.7.2024 | Veranika Patachyts

Was ist die Partner-API?


Die GPS-Trace Partner-API ist ein leistungsstarkes Tool, das Unternehmen ermöglicht, fortschrittliche GPS-Tracking-Funktionen in ihre bestehenden Systeme zu integrieren. Sie bietet eine Vielzahl von Methoden zur Erstellung und Verwaltung von Benutzerkonten und Kundenplänen, zur Konfiguration von Objekten und zur Erstellung benutzerdefinierter Berichte sowie zum Herunterladen von Statistiken.


Wie authentifiziere ich meine Anfragen an die Partner-API?


Die Partner-API verwendet API-Token-Authentifizierung, um sicheren Zugriff zu gewährleisten. Sie müssen ein API-Token von Ihrem Konto generieren, das Sie dann zur Authentifizierung all Ihrer Anfragen verwenden.


Was sind die Hauptfunktionen der Partner-API?


Zu den Hauptfunktionen der GPS-Trace API gehören:

  • Kontoverwaltung
  • Unternehmensverwaltung
  • Verwaltung von Kundenplänen
  • Verwaltung von Objekten
  • Benutzerverwaltung
  • Abrechnungsverwaltung

Partnerplattform


Wie kann ich Benutzer verwalten mit der Partner-API?


Die Partner-API bietet Endpunkte für die Benutzerregistrierung und -verwaltung. Sie können neue Benutzerkonten erstellen, Benutzerinformationen aktualisieren und Kundenpläne sowie Module und Berechtigungen verwalten, um eine sichere und organisierte Benutzerbasis zu gewährleisten.


Wie funktioniert die Kontoverwaltung?


Der CRUD-Unterabschnitt für Konten umfasst Methoden im Zusammenhang mit CRUD (Create, Read, Update, Delete)-Operationen für Konten, einschließlich:

  • Erstellung von Konten: Methoden zur Erstellung neuer Konten im System.
  • Löschen von Konten: Methoden zum Entfernen von Konten aus dem System.
  • Aktualisierung von Konten: Methoden zur Aktualisierung bestehender Kontoinformationen.
  • Abrufen von Kontoinformationen: Methoden zum Abrufen von Details bestimmter Konten.

Bei der Erstellung eines Kundenkontos wird dem Konto eine Anwendung zugewiesen, die dem Kunden Zugriff gewährt. Dies wird durch eine Anfrage implementiert, wobei eines der Pflichtfelder "reg_apps" ist. IDs der Anwendungen umfassen:

  • Ruhavik - 5a5ca87f-7cbe-4540-ab5d-77bf4bf69884
  • Petovik - 962e19f0-6b4a-4f81-a3fe-4b657689b6f9
  • Forguard - b901da51-ce00-4af2-b978-8d0fca8ae1ea

Benutzereinheiten werden gleichzeitig mit der Erstellung eines Kundenkontos erstellt und sind zunächst inaktiv. 

Um das Konto zu aktivieren:

  • sendet der Partner einen speziellen Aktivierungslink an seinen Kunden.
  • Nach dem Klicken auf den Aktivierungslink gibt der Kunde seine einzigartige E-Mail-Adresse (die dem Konto zugeordnet werden soll) und ein Passwort ein.
  • Der Kunde erhält dann eine Registrierungsbestätigungs-E-Mail an die angegebene Adresse. Durch das Folgen des Links in der E-Mail schließt der Kunde den Registrierungsprozess ab, indem er die angeforderten Informationen im Formular eingibt, die Passwort, Login-Schlüssel usw. umfassen können.

Als Ergebnis erstellen Sie mit Hilfe unserer API in nur wenigen Klicks einen neuen Benutzer.


Ist es eine Partner-API oder eine API für GPS-Überwachung?


Es ist definitiv eine Partner-API basierend auf der Funktionalität unseres Partner Panels. Sie können damit nicht Ihre Flotte überwachen. Das Hauptziel ist die Verwaltung und Anpassung von Kundenkonten und Objekten, die Festlegung von Tarifen, die Verwaltung von Analysen und der Verlauf. Mit unserer API können Sie unsere Partnerplattform in Ihr CRM- und Abrechnungssystem integrieren.

GPS Partner API Dokumentation


Wie kann es meinem Geschäft zugutekommen?


Die Partner-API vereinfacht verschiedene betriebliche Aspekte wie Fahrzeugverwaltung, Asset-Tracking und Datenberichterstattung. Durch die Automatisierung dieser Prozesse können Unternehmen den manuellen Aufwand reduzieren und die Rentabilität mühelos steigern.


Kann ich auf historische Tracking-Daten mit der Partner-API zugreifen?


Ja, die GPS-Trace Partner-API ermöglicht den Zugriff auf historische Tracking-Daten.
Diese Daten sind wertvoll für die Leistungsanalyse, die Untersuchung von Vorfällen und die Optimierung zukünftiger Operationen. Beispielsweise können Sie die GET /partner/units/{id}/messages(Get Unit Messages) Methode verwenden, um Nachrichten von einem Gerät (Objekt) auf Forguard abzurufen. Die maximale Anzahl von Nachrichten, die abgerufen werden können, beträgt 10.000, und Sie können auch die Anzahl der letzten Nachrichten angeben, die Sie erhalten möchten.

Beispielanfrage, um die letzten 10 Nachrichten zu erhalten:

curl -X 'GET' \
  'https://api.gps-trace.com/partner/units/<unit id>/messages?count=10' \
  -H 'accept: application/' \
  -H 'X-AccessToken: <your token>'

Die Felder in der Antwort hängen von den vom Tracker gesendeten Parametern ab.


Wie kann benutzerdefinierte Berichterstellung meinem Geschäft helfen?


Benutzerdefinierte Berichterstellung ermöglicht es Ihnen, detaillierte Berichte basierend auf Ihren spezifischen Anforderungen zu erstellen.
Diese Berichte können Daten zur Fahrzeugnutzung und -effizienz enthalten und wertvolle Einblicke für die Entscheidungsfindung und die Verbesserung von Geschäftsstrategien bieten. Beispielsweise sollten Sie die GET /partner/units/{id}/telemetry” (Get Telemetry Data) Methode verwenden, um die neuesten Telemetriedaten des Objekts abzurufen.

Beispielanfrage:

curl -X 'GET' \
  'https://api.gps-trace.com/partner/units/<unit id>/telemetry' \
  -H 'accept: application/' \
  -H 'X-AccessToken: <your token>'

Als Ergebnis laden Sie einen Bericht mit der neuesten Telemetrie-Nachricht jedes von Ihnen angegebenen Geräts herunter.


Wie kann ich mit der Partner-API beginnen?


Um mit der Partner-API zu beginnen, können Sie das Formular auf unserer Website ausfüllen oder uns unter business@gps-trace.com schreiben.