| Sv translation | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
Das RTI (Remote Tracking Interface) ermöglicht den Zugriff auf YellowFox Funktionen und Daten über HTTP von Software DritterDrittanbietern. Die technische Dokumentation und Funktionsübersicht finden Sie hier.
EinleitungDie RTI Schnittstelle bietet Ihnen die Möglichkeit Daten aus YellowFox in andere Systeme zu übertragen. Ebenso haben Sie die Möglichkeit Daten an YellowFox zu übergeben. So können Sie beispielsweise:
Die RTI Schnittstelle bietet noch viele weitere Funktionen, die Sie unserer technischen Dokumentation entnehmen können. Wenn Sie sich dafür interessieren Touren an YellowFox zu übergeben oder Tourdaten abzurufen, sollten Sie sich unseren separaten Tour Webservice anschauen. Voraussetzungen und EinrichtungDie RTI muss vom YellowFox Innendienst für Ihre Firma freigeschaltet werden. Nach erfolgter Freischaltung finden Sie im Menü "Extras" das Untermenü "RTI (Schnittstelle)".Schnittstelle muss für Sie durch unseren Innendienst freigeschaltet werden. Kommen Sie dazu gern auf uns zu. Nachdem das Modul freigeschaltet wurde, finden Sie im Portal über das Hauptmenü → Verwaltung → Administration → RTI Schnittstelle die nötigen Einstellungen. Um RTI Funktionen nutzen zu können, müssen Sie zunächst die benötigten RTI Schlüssel erzeugen. Was ist ein RTI Schlüssel?Die RTI Schnittstelle nutzt eine 2-stufige Authentifizierung. Das bedeutet, dass Sie bei jedem Zugriff 2 Schlüssel mitgeben müssen um unautorisierte Zugriffe zu vermeiden. Diese Schlüssel können Sie über das Portal erzeugen. Ein Schlüssel ist ein zufällig erstellter hexadezimaler Code. RTI Schlüssel sind vertrauliche Informationen und sollten nur weitergegeben werden, sofern es nötig ist. Nur mithilfe dieser Schlüssel sind Daten über die Schnittstelle abrufbar. YellowFox unterscheidet in 4 Arten von Schlüssel:
RTI Schlüssel erzeugenRTI Schlüssel müssen über das Portal erzeugt werden. Gehen Sie dazu in die RTI Einstellungen. Unter Globale Schlüssel können Sie den Firmen- und Importschlüssel erzeugen. Wenn Sie bereits einen Schlüssel erzeugt haben, können Sie diesen auch ändern oder löschen. Eine Änderung würde dazu führen, dass der Schlüssel neu erzeugt wird. Das ist beispielsweise hilfreich wenn Sie den Schlüssel versehentlich an jemanden weitergegeben haben, der nicht auf Ihre Daten zugreifen können soll. Wenn Sie den Schlüssel löschen, sind Funktionen, die diesen nutzen, nicht mehr erreichbar. Über Fahrzeugschlüssel können Sie die Schlüssel für die Fahrzeuge erzeugen. Fahrzeuge können auch ohne den Schlüssel zu entfernen vorübergehend für das RTI gesperrt werden. So können Sie einem Partner vorübergehend Zugriff auf ein Fahrzeug geben, z.B. während es eine bestimmte Tour fährt und anschließend den Zugriff wieder unterbinden. Sie können Fahrzeuge jederzeit aktivieren und wieder deaktivieren. Fahrzeuge sind nicht nur über den RTI Schlüssel identifizierbar, sondern optional auch über einen so genannten RTI Ident. Während der Schlüssel automatisch durch das System vergeben wird, können Sie den Ident frei vergeben. Das ist beispielsweise hilfreich um die Schlüssel einfacher in einem anderen Programm verwalten zu können. RTI Idents können nur in Kombination mit einem passenden Gruppenschlüssel verwendet werden. Eine Anleitung dazu finden Sie in der technischen Dokumentation. Über das Aktionsmenü können Sie weiterhin über RTI Links einige Beispielaufrufe sehen. Unter Fahrzeuggruppen Schlüssel können Sie die Schlüssel für Fahrzeuggruppen erzeugen. Hier sehen Sie auch noch einmal übersichtlich welche Fahrzeuge sich in den jeweiligen Gruppen befinden, ob diese bereits einen Schlüssel haben oder derzeit gesperrt sind. Fahrzeuge ohne Fahrzeugschlüssel werden in Abfragen mit Gruppenschlüsseln auch wenn sie der Gruppe zugeordnet sind nicht aufgeführt. NetzwerkzugangsprofileWenn Sie für Ihre Firma Netzwerkzugangsprofile angelegt haben, so haben diese auch Auswirkungen auf RTI Anfragen. In den Einstellungen des Moduls können Sie Ihrer Firma Profile zuweisen. Anfragen die aus einem unbekannten Netz kommen werden dann automatisch unterbunden. Vollständige FunktionsübersichtEinleitung YellowFox Remote Tracking InterfaceMit Hilfe des YellowFox Remote Tracking Interface (RTI) können unter anderem folgende Funktionen außerhalb des
Die verfügbaren Funktionen und deren Gebrauch sind unter diesem Link detailliert beschrieben. Generierung der benötigten Schlüssel
Das Remote Tracking Interface ist nun eingerichtet und kann verwendet werden. Für Fahrzeuge und Fahrzeuggruppen kann über die Aktion "RTI Links" ein Beispielaufruf generiert werden. Dies gibt Ihnen die Möglichkeit zu sehen, wie ein Aufruf im Betrieb erfolgen sollte und wie eine Rückgabe aussehen kann. Beachten Sie bitte, dass Sie jedem Fahrzeug, dass einer Gruppe angehört, auch einen Fahrzeugschlüssel zuweisen, dass Zuweisen nur eines Gruppenschlüssels reicht nicht, um dieses Fahrzeug mit dem RTI nutzen zu können! EinstelltungenNetzwerkzugangsprofileUm den Zugriff auf die RTI Schnittstelle auf vertrauensvolle Netzwerkadressen zu beschränken (z.B. Unternehmensnetzwerk), gibt es die Möglichkeit Profile zu erstellen und zu verwalten, die bestimmte Netzwerkadressen oder -bereiche beschreiben. Diese Profile können dann der Firma zugeordnet werden. Wenn eine Anfrage über das RTI gestellt wird, wird dann als erstes überprüft, ob die Anfrage von einer IP-Adresse kommt, die über eines der zugeordneten Profile erlaubt ist. Ansonsten wird die Anfrage mit einer Fehlermeldung abgewiesen. Weiterführende Informationen |
| Sv translation | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
The RTI (Remote Tracking Interface) allows you to use YellowFox functions and access its data via HTTP in third party software. You can find the technical documentation here.
Introduction
Introduction YellowFox Remote Tracking InterfaceWith the YellowFox Remote Tracking Interface (RTI) has among others following portal functions:
The description for available functions and their usage can be found via this link. Generate the authorization keys
At every time you are able to generate new keys or to delete them. Please note, that if a new key was generated, the old one will be invalid. The Remote Tracking Interface setup finished and you can use this function. For each vehicle and group with a key there is an additional action "RTI links". Select this action will show a dialog with some example links to see how to use the rti functions with according return values. Please note, if you want to use a group, all belonging vehicles must have a vehicle key. The allocation of a group key is not enough! Settingsnetworkt access profilesIn order to limit access to the RTI interface to trustworthy network addresses (e.g. company network), there is the option of creating and managing profiles that describe certain network addresses or areas.The RTI interface offers the possibility to access data from YellowFox and import it into another system. You might also import new data to Yellowfox. You might for example:
The interface offers much more functions, which you can read about at the technical documentation. If you are interested to import Tours to YellowFox or to access tour data, you might take a look at the separate Tour Webservice. Requirements and SetupThe RTI interface must be activated by our in-house staff. Feel free to contact us. After the module has been unlocked, you can access its settings via the mainmenu → Administration → Administration → RTI Interface. To use the interface you have to generate RTI keys first. What is a RTI key?The RTI interface uses a 2-step-authentification. This means you always have to pass 2 keys to avoid unauthorized access. These keys are generated at the portal. A key is a random hexadecimal code. RTI keys are sensitive information and should only be shared if needed. Only by using these keys you can get data via the interface. YellowFox distinguishes 4 types of keys:
Create RTI keysRTI keys are generated via the portal. Go to RTI Interface settings. At global keys you can generate the company and import key. If you already generated a key, you might also change or delete it. A change would lead to the key being generated again. This might be helpful if you unintentionally shared a key with someone who wasn't supposed to see it. If you remove a key, all functions which use it are not accessible anymore. Via vehicle keys you can generate a key for each vehicle. Vehicles might be deactivated without having to remove the key. For example you could activate a key for a partner while the vehicle is working on a specific tour and after the tour is finished, you can lock the vehicle again. Vehicles can not only be identified by a key, but also by a so called RTI ident. While the key is generated automatically, you can set the ident by yourself. This might be helpful to manage keys easier in another program. Idents can only be used if you combine them with a valid group key. You can find the instructions to use RTI idents at the technical documentation. You can use the action menu to get some example calls via RTI Links. Via vehicle group keys you can generate the keys for vehicle groups. Here you can also see the assignments of vehicles to each group and if the vehicles even have a key or are currently locked. Vehicles without vehicle keys are not considered in group requests even if they are assigned to the group. Network assign profilesIf you created network assign profiles for your company, these do also influence RTI requests. You can assign them to your company at the settings. Request from an unknown network will be quit automatically. Full documentationThese profiles can then be assigned to the company. When a request is made via the RTI, the first thing that is checked is whether the request comes from an IP address that is permitted via one of the assigned profiles. Otherwise the request will be rejected with an error message.Further Informations |