LORVIS Handbuch
Schnittstellen

Überblick

Welche Wege in LORVIS hinein- und hinausführen.

LORVIS hat vier Arten von Schnittstellen. Sie unterscheiden sich darin, wer ruft und womit er sich ausweist — und das ist keine Formalie, sondern bestimmt, was schiefgehen kann.

WegWer ruftAusweisLegt einen Einsatz an
AlarmeingangAlarmierungssystemGeheimnis je Quelleja
FahrzeugstatusLeitstelle, FMSdasselbe Geheimnisnie
Geräte-APIdie FahrzeugtabletsGerätetokenja (vom Fahrzeug aus)
API-Schlüsseleigene ProgrammeSchlüssel je Organisation

Warum Alarm und Status getrennte Adressen haben

Das ist die wichtigste Entscheidung an diesen Schnittstellen, und sie ist ausdrücklich so getroffen worden:

Ein Alarm ist ein Ereignis — „hier ist etwas passiert" — und er legt einen Einsatz an. Ein Status ist ein Zustand des Fahrzeugs: „dieses Fahrzeug ist jetzt 2".

Die FMS-Stufen 1, 2 und 6 haben mit keinem Einsatz zu tun. Beides über dieselbe Adresse zu schicken hieße: jede Statusmeldung trägt die Bedeutung eines Alarms mit sich. Ein Zahlendreher, ein Feld zu viel — und aus „Fahrzeug wieder frei" wird ein Einsatz.

Das ist die Sorte Fehler, die niemand rückgängig macht, weil sie nachts um drei auf sechs Tablets aufblinkt. Deshalb: eigener Weg, dasselbe Geheimnis, und der Statuseingang legt nie einen Einsatz an.

Die Adressen

ZweckAdresse
Alarmhttps://manager.lorvis.de/api/v1/alarme
Fahrzeugstatushttps://manager.lorvis.de/api/v1/fahrzeugstatus

Die vollständige Adresse samt Geheimnis steht im Portal unter Freigaben → Alarmquelle, je eingerichteter Quelle. Sie dort abzuschreiben ist zuverlässiger als sie hier zusammenzusetzen.

Die Beschreibung zum Weitergeben

Wer die Anbindung nicht selbst baut, sondern einem Dienstleister überlässt, gibt ihm resources/api/alarm-webhook.yaml — die maschinenlesbare Beschreibung des Alarmeingangs. Für die Geräte-API liegt eine OpenAPI-Beschreibung mit 33 Endstellen bereit; im Portal ist sie unter Schnittstellen → Dokumentation auch zum Ausprobieren eingerichtet.

On this page