FAQ Web API

Ich habe mich auf netztransparenz.de für die Rolle "WebApiReader" erfolgreich registriert. Leider habe ich keine weiteren Informationen zu den URLs/ Einsprungspunkten für die API gefunden.

Je nachdem welchen API Endpunkt sie ansteuern wollen, sind die in der URL enthaltenen Angaben für den Datenkategorie „{data}“, den Datenpunkt „{product}“ und der  abgefragte Zeitraum „{dateFrom} bzw. {dateTo} in der folgenden URL anzupassen: https://ds.netztransparenz.de/api/v1/data/{data}/{product}/{dateFrom}/{dateTo}

Für weiterführende Informationen sei auf die Web API-Dokumentation und die zur Verfügung stehende JSON-Datei verwiesen. 

Die Swagger Umgebung erreichen Sie über den folgenden Link: https://extranet.netztransparenz.de/DesktopModules/LotesDataManagementExtranet/Swagger/index.html?version=public

Wenn ich mich mit meinen API-Zugangsdaten der API-Registrierung im Extranet von netztransparenz.de eingeloggt habe und auf den Link „API-Weiterleitung“ klicke, funktioniert dies nicht – woran liegt das?  

Der Link funktioniert, sofern Ihre Browsereinstellungen Popups und/oder Weiterleitungen erlauben. Ist dies der Fall, öffnet sich ein Popup-Fenster. Ist dies nicht der Fall, müssen Sie ggf. Ihre Browsereinstellungen anpassen.  
Beim Browser „Edge“ erscheint beispielsweise in der Eingabezeile ein Text „Popups geblockt“. Wenn Sie dem Öffnen des Popups zustimmen, ist der Aufruf der Swagger-Seite möglich. 

Wie kann ich die Web-APIs in der Swagger-Umgebung nutzen bzw. testen?  

Sofern Sie sich für die API-Nutzung registriert haben und im ÜNB-Extranet mindestens einen Client angelegt haben, können Sie in der Swagger-Umgebung alle Web-APIs testen, indem Sie oben rechts auf den Button „Authorize“ klicken.  
In der ersten Maske geben Sie bitte Ihre persönliche ClientID und ihr ClientSecret ein. Jetzt können Sie die einzelnen APIs über den Button „Try it out“ und Befüllung der Eingabefelder nutzen. 

Wenn ich Daten in der Swagger Umgebung abrufen möchte, erhalte ich den Fehler 401 – Unauthorized.

Sofern Sie sich für die API erfolgreich registriert und bereits einen Client angelegt haben, ist ein Datenabruf grundsätzlich möglich. Bitte beachten Sie insb. die Antwort zur FAQ Frage „Wie kann ich die Web-APIs in der Swagger-Umgebung nutzen bzw. testen“.

Ist ein automatisierter Abruf der Web-APIs mittels Machine-to-Machine-Kommunikation möglich?

Mit der Umstellung auf OAuth 2.0 Client Credential Grant ist eine Machine-to-Machine-API-Nutzung möglich.