Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Sv translation
languagede

Grundlegende Telematikfunktionen von YellowFox werden externen Programmen zugänglich gemacht.

Panel
titleInhaltsverzeichnis

Table of Contents
 

Allgemein

Der Nutzer der Schnittstelle wird einen Befehl an den Webserver senden und erhält dabei eine Antwort zurück. Die Übertragung der Nutzdaten erfolgt über das Protokoll http bzw. https, so dass normalerweise keinerlei Anpassungen im IT-Equipment des Kunden notwendig sind. Das Remote Tracking Interface (RTI) erhält dabei eine speziell formatierte Anfrage und beantwortet diese mit dem Ergebnis des auf die Anfrage hin ausgeführten Befehls. Das RTI agiert dabei immer nur auf eine Anfrage. Es kann weder Daten von selber versenden noch ohne Zutun des Kunden von allein tätig werden.

Das RTI lässt sich z.B. für folgende Dinge nutzen:

  • Abfrage von Fahrzeugstandorten
  • Änderung von trackingeinstellungen
  • Konfiguration von Hardwarezubehör wie Displays
  • Versenden von Aufträgen
  • Empfangen von Auftragsstatusmeldungen
  • Versenden und Empfangen von Textnachrichten

Die Funktionen des RTI können auf einfachste Weise mit Anwendungen wie Google Earth getestet werden.

Aktivierung

Das RTI wird durch den Support bzw. Innendienst freigeschaltet. Kontaktieren Sie uns einfach an um dieses Modul für sich freizuschalten. Im Portal können Sie dann unter Extras -> RTI (Schnittstelle) RTI Schlüssel für Ihre Firma und den zugehörigen Fuhrpark erzeugen. Diese dienen dann als Authentifizierung.

Basisadressierung

Basisadresse für alle Abfragen ist http://map.yellowfox.de/rti/ bzw https://map.yellowfox.de/rti/

Beschreibung der Funktionsweise

Die Authentifizierung an der RTI Schnittstelle erfolgt über RTI Schlüssel. Diese finden Sie im Portal unter Extras → RTI Schnittstelle. Ihr Zugang besitzt zwei zentrale Schlüssel: den Firmenschlüssel und den Importschlüssel. Weiterhin können Sie für jedes Fahrzeug und jede Fahrzeuggruppe einen eigenen Schlüssel erzeugen. Je nach RTI Funktion benötigen Sie eine bestimmte Kombi an Schlüsseln. Informationen dazu finden Sie in der Beschreibung der jeweiligen Funktion. Die Schlüssel sind pro Firma eindeutig.

Bei RTI Schlüsseln handelt es sich um einen Hexadezimal Schlüssel. Dieser wird zufällig generiert und kann beliebig oft neu erstellt werden. Für Fahrzeuge haben Sie optional auch die Möglichkeit eigene RTI Idents zu vergeben. Diese sind jedoch ausschließlich in einer 2-stufigen Authentifizierung nutzbar.

RTI Schlüssel müssen bei jeder Anfrage mitgegeben werden, Sie sind jedoch nicht in der jeweiligen Antwort enthalten. 

Folgende Schlüssel sind für die Anmeldung an YellowFox wichtig:

  • company: Dieser Schlüssel muss immer angegeben werden und identifiziert Ihren Firmenzugang.
  • import: Hierbei handelt es sich um eine Art Universalschlüssel. Dieser kann genutzt werden um neue Daten über die Schnittstelle einzupflegen oder auch um Daten zu allen Fahrzeugen abzurufen.
  • vehicle: Identifiziert ein einzelnes Fahrzeug. Kann auf unterschiedliche Art und Weisen angegeben werden:
    • als Standard RTI Schlüssel
    • per RTI Ident: Hierbei handelt es sich um eine 2-stufige Authentifizierung. Zusätzlich muss entweder ein passender Fahrzeuggruppenschlüssel oder der Import Schlüssel angegeben werden.
      • mit GruppenschlüsselFormat{"type":"car_ident","groupKey": "RTI_GROUP_KEY","ident": "RTI_IDENT"}mit Importschlüssel: {"type":"car_ident","importKey": "RTI_IMPORT_KEY","ident": "RTI_IDENT"}
  • group: Identifiziert eine Fahrzeuggruppe und alle darin enthaltenen Fahrzeuge, welche selbst einen RTI Schlüssel besitzen. Wenn Sie einen Gruppenschlüssel verwenden, stellen Sie sicher, dass jedes Fahrzeug dieser Gruppe auch einen Fahrzeugschlüssel hat! 
  • Datumsstempel, um Caching der Befehlsanfrage zu vermeiden.

Ausführung als ?company=HEXKEY&vehicle=HEXKEY2

Fehlerwerte

Bei der Rückgabe "ERROR:Text" enthält "Text" die Fehlerbeschreibung. Mögliche Fehlercodes finden Sie hier.

...