Zum Inhalt springen

Wiki-Quellcode von RTI - Schnittstelle

Version 5.1 von YellowFox_RD am 2026/07/14 10:50
Zeige letzte Bearbeiter
1 (% class="box" %)
2 (((
3 Inhaltsverzeichnis
4 )))
5
6 {{toc/}}
7
8 Das RTI (Remote Tracking Interface) ermöglicht den Zugriff auf YellowFox Funktionen und Daten über HTTP von Software Drittanbietern. Die technische Dokumentation und Funktionsübersicht finden Sie [[hier>>doc:YellowFox Remote Tracking Interface.Funktionen.WebHome]].
9
10 = Einleitung =
11
12 Die 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:
13
14 (((
15 * Positionsdaten abrufen
16 * Fahrzeugeinstellungen ändern
17 * Formular- und Auftragsdaten holen
18 * neue Aufträge und Nachrichten versenden
19 * Dateien hochladen
20 * Zeitbuchungen verwalten
21 * Adressen importieren
22 )))
23
24 Die RTI Schnittstelle bietet noch viele weitere Funktionen, die Sie unserer [[technischen Dokumentation>>doc:YellowFox Remote Tracking Interface.WebHome]] entnehmen können. Wenn Sie sich dafür interessieren Touren an YellowFox zu übergeben oder Tourdaten abzurufen, sollten Sie sich unseren separaten [[Tour Webservice>>https://map.yellowfox.de/rti/docu/tour/]] anschauen.
25
26 = Voraussetzungen und Einrichtung =
27
28 Die RTI 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.
29 Um RTI Funktionen nutzen zu können, müssen Sie zunächst die benötigten RTI Schlüssel erzeugen.
30
31 == Was ist ein RTI Schlüssel? ==
32
33 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:
34
35 (((
36 * Firmenschlüssel: dieser Schlüssel identifiziert Ihre Firma und muss bei jeder Anfrage mitgegeben werden.
37 * Fahrzeugschlüssel: dieser Schlüssel identifiziert ein einzelnes Fahrzeug. Er wird für Anfragen benötigt, die fahrzeugbezogene Daten wie z.B. Ortungsdaten zurückgeben.
38 * Gruppenschlüssel: dieser Schlüssel identifiziert eine Fahrzeuggruppe. Mit einem Gruppenschlüssel können Sie z.B. Ortungsdaten aller Fahrzeuge abrufen, die dieser Gruppe zugeordnet sind. **ACHTUNG: Es werden nur Daten für Fahrzeuge ausgegeben, die auch selbst einen Fahrzeugschlüssel besitzen!**
39 * Importschlüssel: dieser Schlüssel agiert als universeller Schlüssel. Er wird benötigt um Daten von allen Fahrzeugen abzurufen oder auch auf personenbezogene Daten zuzugreifen.
40 )))
41
42 == RTI Schlüssel erzeugen ==
43
44 RTI 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.
45 Ü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>>doc:YellowFox Remote Tracking Interface.Funktionen.WebHome]]. Über das Aktionsmenü können Sie weiterhin über RTI Links einige Beispielaufrufe sehen. 
46 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.
47
48 = Kostenpflichtige RTI-Funktionen =
49
50 Neben den Netzwerkzugangsprofilen können Sie in den Einstellungen der RTI-Schnittstelle auch spezifische Funktionsfreigaben verwalten.
51
52 == Wo ist die Einstellung zu finden? ==
53
54 Navigieren Sie im Portal über das Hauptmenü → Einstellungen (Zahnrad-Symbol) [[image:zahnrad.png]]→ Administration → RTI Schnittstelle.
55 Wechseln die Sort auf den Tab für die Einstellungen (Schraubenschlüssel-Symbol) [[image:schraubenschluessel_.png]] ganz rechts und wählen Sie im linken Menü den Punkt Berechtigungen aus.
56
57 == Kostenpflichtige RTI-Funktionen freigeben ==
58
59 Die Nutzung einiger RTI-Funktionen verursacht zusätzliche Kosten, da diese kostenpflichtige Zusatzfunktionen aktivieren können. Um unerwünschte Kosten zu vermeiden, müssen diese Funktionen explizit freigegeben werden:
60
61 * Aktivieren: Setzen Sie den Haken bei „**kostenpflichtige RTI-Funktionen aktivieren“** und bestätigen Sie die Änderung mit Speichern.
62 * Deaktiviert-Status: Ist die Option nicht aktiv, geben die betroffenen Funktionen bei der Benutzung lediglich einen Fehlercode zurück.
63
64 == Welche Funktionen betrifft das? ==
65
66 Die Freigabe betrifft Funktionen aus den folgenden Hauptbereichen der RTI-Schnittstelle:
67
68 * **Abfrageseiten**
69 ** Abruf von Fahrzeug- und Personenlisten, aktuellen Fahrzeugpositionen (auch als generierte Karte), hinterlegten Berichten, übertragenen RS-232-Daten, Tour-Workflows sowie hochgeladenen Dateien (z. B. Digitacho-Daten, Bilder oder Unterschriften).
70 * **Abwesenheitsverwaltung**
71 ** Abrufen der angelegten Abwesenheiten für alle oder einzelne Mitarbeiter.
72 * **Adressverwaltung **
73 ** Erstellung und Pflege von Kundenadressen (inkl. Massenlöschung) sowie das Erstellen, Bearbeiten und Löschen von servergestützten Gebieten (Geofences) über einen integrierten iFrame, inklusive der Zuordnung von Fahrzeugen zu diesen Gebieten.
74 * **Aufträge und Nachrichten**
75 ** Erstellung, Vorlagenverwaltung und Versand von Nachrichten sowie einfachen Serviceaufträgen (inkl. Statusmeldungen und Widerruf) an Fahrzeug-Displays; Abruf und Auswertung gesendeter Aufträge und empfangener Formulardaten (inkl. Formularaufbau); Wegoptimierung für berechtigte Karten-Setups.
76 * **Benutzerwaltun**
77 ** Erstellung und Löschung von befristeten Benutzerzugängen.
78 * **Dateiablage**
79 ** Abruf der aktuellen Ordnerstruktur (inklusive Dateien und IDs zur Referenzierung in Nachrichten oder Aufträgen) sowie das Erstellen, Bearbeiten und Verwalten von Ordnern, Datei-Metadaten und Datei-Uploads.
80 * **Digitacho**
81 ** Abruf von fahrerbezogenen Echtzeit-Informationen (wie Lenk- und Arbeitszeiten, Restlenkzeiten und Schichtdaten für Tag, Woche und Doppelwoche), Abruf ausgelesener Daten aus Digitacho-Dateien sowie Auslesen aller Buchungen der D8-Schnittstelle.
82 * **ETA**
83 ** Initiierung von Ankunftszeit-Abfragen unter optionaler Berücksichtigung der aktuellen Fahrer-Schichtdaten und der realen Fahrzeugposition.
84 * **Fahrzeugeinstellungen**
85 ** Steuerung der Ortungslogik (z. B. Aktivierung des Bewegungsmelders, einmalige Ortungen, Konfiguration von Ortungs-, Weg-, Zeit- oder Kurswechsel-Intervallen); Verwaltung von Fahrzeuggruppen-Zuweisungen und Display-Einstellungen; Kilometerstandspflege (z. B. Setzen des Kilometerstands, Korrekturfaktoren und Abruf von Kilometerstandsabgleichen).
86 * **Objektverwaltung**
87 ** Abruf aller registrierten Objekte samt deren Profil- und Gruppenzuweisungen, IDs, Detailfeldern und zugehörigen Objektgruppen; Abfrage des aktuellen Status und der Positionen einzelner oder mehrerer Objekte sowie der Auswertung von Aktivitäten und Positionsupdates (z. B. in Verbindung mit YellowFox Beacons).
88 * **Personalverwaltung**
89 ** Erstellung, Bearbeitung und Löschung von Personaldaten; Abfrage aller im System angelegten Personen; Verwaltung der Führerscheinkontrolle (Aktivieren/Deaktivieren für einzelne Personen sowie Import durchgeführter Führerscheinkontrollen).
90 * **Positionen**
91 ** Abruf von FMS-Fahrzeugdaten (Fleet Management System) sowie Auswertung aller Grenzübertritte Ihrer Fahrzeuge, bei denen ein Fahrer im System angemeldet war.
92 * **Zeiterfassung**
93 ** Abruf aller empfangenen Zeiterfassungsbuchungen im gewählten Zeitraum; Abfrage aller verfügbaren Tätigkeiten und Kostenstellen sowie das Erstellen, Bearbeiten und Löschen von Kostenstellen im System.
94
95 Für mehr Informationen kontaktieren Sie bitte unseren Support.
96
97 == Vollständige Funktionsübersicht ==
98
99 [[Technische Dokumentation>>doc:YellowFox Remote Tracking Interface.Funktionen.WebHome]]
100
101
102 == Netzwerkzugangsprofile ==
103
104 Wenn 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.
105
106 =
107 =