FAQ WebAPI

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 WebAPI-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

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

Sofern Sie sich für die API-Nutzung registriert haben und im WebAPI-Portal mindestens einen Client angelegt haben, können Sie in der Swagger-Umgebung alle WebAPIs 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 WebAPIs in der Swagger-Umgebung nutzen bzw. testen“.

Ist ein automatisierter Abruf der WebAPIs 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.