Digitaler Befehl Training API
Version:Eine RESTful API zur Integration des Digitalen Befehls in eigene Schulungssysteme. // A RESTful API for integrating Digitaler Befehl into your own training systems.
Beschreibung
Die Digitaler Befehl Training API ist eine standardisierte Schnittstelle der Schulungsumgebung des Digitalen Befehls, die speziell für die Schulung von Triebfahrzeugführer:innen (Tf) im digitalen Befehlsprozess entwickelt wurde. Sie ermöglicht es Eisenbahnverkehrsunternehmen und Bildungsdienstleistern, die Aktionen von Fahrdienstleiter:innen (Fdl) im Digitalen Befehl direkt in ihren eigenen Schulungssystemen auszuführen - ohne dass reale Fahrdienstleiter:innen beteiligt sind. Die API umfasst folgende fachliche Funktionen:
- Erstellung einer neuen Befehlsnachricht für eine Zugnummer (mit eigenem Befehlsinhalt)
- Abfrage der aktuellen Daten einer zuvor erstellten Befehlsnachricht
- Bestätigung der Tf Zugstandort-Eingabe für eine zuvor erstellte Befehlsnachricht
- Korrektur der Tf Zugstandort-Eingabe für eine zuvor erstellte Befehlsnachricht
- Löschen einer zuvor erstellten Befehlsnachricht
Description
The Digitaler Befehl Training API is a standardized interface of the Digitaler Befehl training environment, specifically developed to train drivers in the Digital Instruction (DI) process. It enables railway undertakings and educational service providers to execute dispatcher (Fdl) actions within the application directly inside their own training systems-without requiring real dispatchers. The API provides the following functional capabilities:
- Creation of a new DI message for a given train number (with custom content)
- Retrieval of the current data of a previously created DI message
- Confirmation of the driver's train-location input for a previously created DI message
- Correction of the driver's train-location input for a previously created DI message
- Deletion of a previously created DI message
§ 1 Geltungsbereich
(1) Für die Nutzung der API "Digitaler Befehl - Trainingsanwendung" (nachfolgend "API") gelten ergänzend zu den Allgemeinen Nutzungsbedingungen des DB API Marketplace die nachfolgenden besonderen Nutzungsbedingungen in ihrer jeweils gültigen Fassung.
(2) Im Falle widersprüchlicher Regelungen gehen die Bestimmungen dieser besonderen Nutzungsbedingungen vor.
§ 2 Lizenz
(1) Die über die API bereitgestellten Datensätze stehen unter der Lizenz Creative Commons Attribution 4.0 International (CC BY 4.0).
(2) Der Lizenznehmer ist verpflichtet, die Lizenzbedingungen der CC BY 4.0 in vollem Umfang einzuhalten.
§ 3 Zugangsberechtigung
(1) Zugang zur API erhalten ausschließlich Eisenbahnverkehrsunternehmen (EVU) sowie Bildungsdienstleister, die Schulungen für Triebfahrzeugführer:innen im Zusammenhang mit dem Digitalen Befehl der DB InfraGO AG durchführen.
(2) Der Zugang kann durch Abonnieren eines entsprechenden Nutzungsplans beantragt werden.
(3) Die Freischaltung erfolgt erst nach positiver Prüfung der Zugangsberechtigung durch die DB InfraGO AG. Ein grundsätzlicher Anspruch auf Zugang besteht nicht.
§ 4 Zulässige Nutzung
(1) Die Nutzung der API ist ausschließlich zu folgenden Zwecken gestattet:
- Schulung und Training von Triebfahrzeugführer:innen,
- interne Test- und Qualifizierungsmaßnahmen im Zusammenhang mit dem Digitalen Befehl.
(2) Jede hiervon abweichende Nutzung ist unzulässig.
§ 5 Unzulässige Nutzungsarten
Dem Nutzer ist insbesondere untersagt:
- Reverse Engineering, Dekompilierung oder sonstige Rekonstruktionsversuche;
- Scraping oder massenhaftes Auslesen von Daten durch extraktive Verfahren;
- automatisierter exzessiver Zugriff oder jeder Zugriff, der den Systembetrieb beeinträchtigen kann;
- Nutzung der API oder der bereitgestellten Inhalte zur Entwicklung konkurrierender Produkte oder Dienstleistungen.
§ 6 Haftungsausschluss / Gewährleistung
(1) Die API wird dem Nutzer "wie gesehen" ("as is") bereitgestellt.
(2) Die DB InfraGO AG übernimmt keinerlei Gewährleistung, insbesondere nicht für:
- Verfügbarkeit oder ununterbrochene Nutzbarkeit,
- Fehlerfreiheit, Richtigkeit oder Vollständigkeit der Daten,
- das Erreichen bestimmter Ergebnisse,
- Kompatibilität mit der Systemumgebung des Nutzers oder Dritter.
(3) Es besteht keinerlei Zusicherung, dass die API jederzeit störungsfrei, kontinuierlich oder in bestimmtem Umfang bereitgestellt wird.
§ 7 Sicherheitspflichten und Missbrauchsschutz
(1) Der Nutzer hat seinen API-Key vertraulich zu behandeln und gegen unbefugten Zugriff zu schützen.
(2) Eine Weitergabe des API-Keys an Dritte ist untersagt.
(3) Bei Verdacht auf Missbrauch, ungewöhnliche Zugriffsmuster oder Sicherheitsrisiken ist die DB InfraGO AG berechtigt, API-Keys temporär oder dauerhaft zu sperren.
§ 8 Betrieb und Service-Level
(1) Die technische Betriebszeit der API beträgt grundsätzlich 24 Stunden am Tag, 7 Tage die Woche.
(2) Die Servicezeit für Supportanfragen beträgt Montag bis Freitag, 08:00 bis 17:00 Uhr (außer an gesetzlichen Feiertagen).
(3) Während der Servicezeit erfolgt die Bearbeitung von gemeldeten Störungen nach Maßgabe der verfügbaren Ressourcen.
(4) Ein Anspruch auf bestimmte Reaktions- oder Wiederherstellungszeiten besteht nicht.
§ 9 Störungsmeldungen
(1) Störungen der API sind unverzüglich an das Postfach Digitaler Befehl zu melden.
(2) Zur effizienten Bearbeitung hat die Meldung mindestens folgende Angaben zu enthalten:
- Bezeichnung der betroffenen API oder des betroffenen Dienstes,
- Datum und Uhrzeit des Auftretens,
- Name der Anwendung bzw. des Konsumenten im DB API Marketplace,
- Konsumenten-Organisation (sofern vorhanden),
- detaillierte Fehlerbeschreibung oder Fehlermeldung,
- Beispielaufrufe oder aussagekräftige Beispieldaten zur Reproduktion.
(3) Unvollständige Meldungen können die Bearbeitung verzögern.
§ 10 Änderungen und Weiterentwicklung der API
(1) Die DB InfraGO AG ist berechtigt, Funktionen, Parameter oder Inhalte der API jederzeit zu ändern, zu erweitern, einzuschränken oder einzustellen.
(2) Die DB InfraGO AG kann Endpunkte anpassen oder entfernen.
(3) API-Versionen können abgekündigt und durch neue Versionen ersetzt werden. Ein Anspruch auf Weiterbetrieb bestimmter Versionen besteht nicht.
§ 11 Wartungsfenster
(1) Die DB InfraGO AG führt zur Sicherstellung der technischen Stabilität und Weiterentwicklung der API regelmäßig planmäßige Wartungsarbeiten durch. Diese finden in der Regel etwa alle zwei Monate statt und umfassen regelmäßig eine Dauer von max. 60 Minuten.
(2) Soweit möglich, werden API-Konsumenten mindestens zwei Wochen vor Durchführung eines planmäßigen Wartungsfensters über den geplanten Zeitraum und die voraussichtlichen Auswirkungen informiert.
(3) Darüber hinaus kann es erforderlich sein, ad-hoc-Wartungsfenster kurzfristig einzurichten, insbesondere bei sicherheitsrelevanten Ereignissen, Störungen oder dringenden technischen Erfordernissen. In diesen Fällen erfolgt eine Information der API-Konsumenten so früh wie möglich.
(4) Während Wartungsfenstern kann es zu vorübergehenden Einschränkungen oder Unterbrechungen der Verfügbarkeit der API kommen. Ein Anspruch auf Aufrechterhaltung des Betriebs während solcher Wartungszeiten besteht nicht.
§ 12 Schlussbestimmungen
(1) Sollten einzelne Bestimmungen dieser Nutzungsbedingungen unwirksam sein oder werden, berührt dies die Wirksamkeit der übrigen Regelungen nicht.
(2) Im Übrigen gelten die gesetzlichen Vorschriften.
Zugehörige APIs
Nutzungspläne
Um einen Nutzungsplan zu abonnieren, melde Dich an oder registriere Dich.
|
Basis Paket
Kostenloser Zugang mit unbegrenzter Laufzeit, Servicezeit Mo-Fr 08:00-17:00 Uhr (außer an gesetzlichen Feiertagen), Limits: 10 Anfragen pro Sekunde, 4.000 Anfragen pro Tag (Hardlimit). Freischaltung erforderlich. |
Plus Paket
Kostenloser Zugang mit unbegrenzter Laufzeit und erhöhten Limits, Servicezeit Mo-Fr 08:00-17:00 Uhr (außer an gesetzlichen Feiertagen), Limits: 15 Anfragen pro Sekunde, 8.000 Anfragen pro Tag (Hardlimit). Freischaltung erforderlich. |
Testzugang
Kostenloser Testzugang für 6 Monate, Servicezeit Mo-Fr 08:00-17:00 Uhr (außer an gesetzlichen Feiertagen), Limits: 1 Anfrage pro Sekunde, 100 Anfragen pro Tag (Hardlimit). Freischaltung erforderlich. |
|
|---|---|---|---|
|
2 Ratenbegrenzungen *
|
2 Ratenbegrenzungen *
|
2 Ratenbegrenzungen *
|
|
|
POST
/befehlsnachrichten
GET
/befehlsnachrichten/{id}
PATCH
/befehlsnachrichten/{id}
|
|
|
|