So startest Du einfach mit den APIs
Auf dieser Seite erfährst Du, wie Du in 4 Schritten zu einem erfolgreichen API Aufruf kommst.
Über den "Getting Started"-Link auf der Startseite kannst Du diese Seite jederzeit
erneut aufrufen.
01
Registrieren und Anmelden
Um den DB API Marketplace nutzen zu können, musst Du Dich zunächst als Benutzer registrieren.
Zur Registrierung benötigst Du ein BahnID Konto, welches im Rahmen des Registrierungsprozesses mit angelegt werden kann.
Die Registierung erfolgt in folgenden Schritten:
-
Registrierung starten:
Mit der Registrierung stimmst Du den Nutzungsbedingungen des DB API Marketplace zu.
Gehe weiter zu BahnID. -
Weiterleitung zu BahnID:
Auf der BahnID Seite wählst Du Registrieren, wenn Du noch keine BahnID hast oder Anmelden, wenn Du schon eine BahnID besitzt. -
Wenn Du Dich bei BahnID registrierst, wird Deine E-Mail-Adresse verifiziert und Du musst den zugesendeten Bestätigungscode eingeben. Bei einer Anmeldung meldest Du Dich mit Deinem existierenden Account bei BahnID an. Anschließend gibst Du Deine Daten Anrede, Name, Vorname, E-Mail zur Nutzung durch den DB API Marketplace frei. Du wirst dann zurück zum DB API Marketplace geleitet, Dein Benutzerkonto wird im DB API Marketplace angelegt und Du bist direkt im Portal angemeldet.
Nach erfolgreicher Registrierung kannst Du Dich am Portal anmelden.
02
Neue Anwendung erstellen
Um eine API nutzen zu können, benötigst Du eine sogenannte Anwendung, die einem technischen Client
entspricht.
Gib der Anwendung einen Titel und bei Bedarf eine Beschreibung. Das Feld "OAuth-Umleitungs-URL(s) der
Anwendung" muß nicht ausgefüllt werden.
WICHTIG: Beim Anlegen der Anwendung wird das sogenannte Client Secret (API Key) angezeigt. Kopiere das Client Secret (API Key) und bewahre es in Deinen Unterlagen auf, da es nur einmalig während dieses Vorgangs angezeigt wird.
03
Katalog durchsuchen und Produkt abonnieren
Öffne den API-Katalog und wähle ein Produkt, das Dich interessiert.
Abonniere das Produkt, indem Du bei einem passenden Nutzungsplan auf den zugehörigen "Abonnieren"-Button
klickst.
Im weiteren Verlauf musst Du die zuvor angelegte Anwendung auswählen und das Abonnement bestätigen.
04
API aufrufen
Wähle das abonnierte Produkt aus dem Katalog aus und gehe zu der API, die Du aufrufen möchtest.
Entscheide Dich für eine Ressource auf der linken Seite und wählen den Reiter "Versuch es!".
Kontrolliere, dass im Feld Client ID Deine Anwendung ausgewählt ist und kopiere das Client Secret (API Key) im Feld "Client Secret (API Key)". Führe dann den API Aufruf über den "Senden"-Button aus.
Für einen API Aufruf außerhalb des API Portals, z.B. mit Postman, musst Du (je nach geforderter API Security) die Client ID/Client Secret (API Key) Deiner Anwendung im Header als DB-Client-Id/DB-Api-Key setzen.
Arbeiten mit Organisationen
Bei der Registrierung wurde automatisch eine Konsumentenorganisation (oder kurz Organisation) mit Deinem Vor- und Nachnamen angelegt. Du findest dazu einen entsprechenden Eintrag rechts oben in der Menüleiste neben Deinem Profil. Eine Organisation ist eine Art Arbeitsbereich, in dem Deine Anwendungen und Abonnements verwaltet werden. Du bist der Eigner dieser Organisation und zunächst das einzige Mitglied. Wenn Du in einem Team arbeitest, legst Du Dir am besten eine neue Organisation z.B. mit Deinem Teamnamen an. Du kannst dann weitere Personen als Mitglieder in diese Organisation einladen. Mitglieder einer Organisation können gemeinsam Anwendungen und Abonnements verwalten und Testaufrufe abonnierter APIs durchführen.