Versions Compared

Old Version 11

changes.mady.by.user YellowFox R&D

Saved on

compared with

New Version 12

changes.mady.by.user YellowFox R&D

Saved on

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

Folgende Parameter sind für die Anmeldung an YellowFox wichtig:

  • company, als HEXadezimalKey auszuführen, kann vom Kunden selber neu generiert werden. Dieser Key wird in jeder Anfrage mitgesendet. Antworten enthalten diesen Key nicht. Der Key dient zur Authentifizierung. Dieser Key wird pro Kunde generiert und enthält unter anderem die Firmenid
  • vehicle, als HEXadezimalKey auszuführen, kann vom Kunden selber neu generiert werden. Dieser Key wird bei Anfragen die Fahrzeuge betreffen mitgesendet. Antworten enthalten diesen Key nicht. Der Key dient als Fahrzeugkennung. Dieser Key wird pro Fahrzeug generiert.
  • group, als HEXadezimalKey auszuführen, kann vom Kunden selber neu generiert werden. Dieser Key wird bei Anfragen die Fahrzeuggruppen betreffen mitgesendet. Antworten enthalten diesen Key nicht. Der Key dient als Fahrzeugkennung oder Gruppenkennung. Dieser Key wird pro Gruppe generiert. 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&ts=yyyymmddhhmmsszzzzzzzz

  • yyyy = Jahr, vierstellig
  • mm - Monat, zweistellig
  • dd - Tag, zweistellig
  • hh - Stunde, zweistellig
  • mm - Minute, zweistellig
  • ss - Sekunde, zweistellig
  • zzzzzzzz - Zaehler für Anfrage, die Antwort enthält diesen Zaehler

Fehlerwerte

Bei der Rückgabe "ERROR:Text" enthält "Text" die Fehlerbeschreibung. Mögliche Fehler:

Abarbeitungsfehler

Mögliche Fehlercodes werden unter Fehlerwerte beschriebenfinden Sie hier.

Sv translation
languageen

Goal of this application is to provide the basic tracking functionality of YellowFox to third party software. Easy use and strong security were scopes during development.

Panel
titleIndex

Table of Contents
 

Common

Goal of this application is to provide the basic tracking functionality of YellowFox to third party software. Easy use and strong security were scopes during development. The user send commands via http to servers and receives the answers, positions, maps via the same way.

RTI can be used for example:

  • Query of vehicle positions
  • change of tracking settings
  • configuration of displays
  • send orders and messages
  • receive order states

Activation

RTI must be activated from our support. Please feel free to contact them.

Base address

http://map.yellowfox.de/rti/ or https://map.yellowfox.de/rti/

Description of functioning

Following paramater are mandatory to authentificate with YellowFox:

  • company, a hexkey to authentificate the company. Can be redefined by customer. This key must be send at every request. No response contains this key.
  • vehicle, a hexkey to authentificate the vehicle. Can be redefined by customer. No response contains this key.
  • group, a hexkey authentificate a group.  Can be redefined by customer. No response contains this key.WIf you use a group key, please check that every car in this group also have a rti key!

 

Execute as ?company=HEXKEY&vehicle=HEXKEY2

Error codes

If "ERROR:Text" is returned. "Text" contains the error description. Possible error codes ca you find here.