Allgemeine API Nutzungshinweise

API Nutzerauthentifizierung

Ab dem 20.10.2022 wurde die Nutzerauthentifizierung auf die Methode OAuth2.0 Client Credential Grant umgestellt, welches den API Datenabruf generell vereinfacht und eine Machine-to-Machine Anbindung ermöglicht. Weiterführende Spezifikationen zu OAuth2.0 sind beispielsweise auf https://oauth.net/specs/ zu finden.

API Registrierung

Für den Zugriff auf die API Endpunkte muss in einem ersten Schritt der API Registrierungsprozess durchlaufen werden, um damit personalisierte Zugangsdaten für das Extranet und damit die Client Verwaltung zu erhalten. Wenn Sie sich registrieren möchten, klicken Sie bitte auf den Link https://extranet.netztransparenz.de/APIRegistrierung. Eine Schritt-für-Schritt Anleitung des Registrierungsprozesses finden Sie im Abschnitt API Dokumentation (siehe unten).

API Client Verwaltung

Für den Zugriff auf die API Endpunkte müssen Sie sich in einem zweiten Schritt mindestens einen Client anlegen. Dies ist über einen Login in das Extranet möglich. Hierzu klicken Sie bitte im Footer der Netransparenz.de auf „Extranet“, loggen sich ein und folgen den Anweisungen innerhalb der Client Verwaltung (OAuth Manager). Im Zuge dessen erhalten Sie je Client eine individuelle „Client_ID“ und ein individuelles „Client_Secret“. Bitte speichern Sie sich Ihr „Client_Secret“ separat ab, da es Ihnen nur 1x angezeigt wird. Eine Schritt-für-Schritt Anleitung der Client Verwaltung finden Sie im Abschnitt API Dokumentation (siehe unten).

API Datenabruf 

Als dritten Schritt benötigen Sie für den Zugriff auf die API Endpunkte mindestens die folgenden Informationen: 

• Individuelle Client_ID (gemäß Client Verwaltung)
• Individuelles Client_Secret (gemäß Client Verwaltung)
• Grant Type: 'client_credentials' 
• Access Token URL: https://identity.netztransparenz.de/users/connect/token 
• URL API Endpunkte (Beispiel): https://ds.netztransparenz.de/api/v1/data/{data}/{product}/{dateFrom}/{dateTo}

Über die Swagger Umgebung besteht zudem für registrierte API Nutzer die Möglichkeit die verfügbaren API Endpunkte für einen angelegten Client zu testen (https://extranet.netztransparenz.de/DesktopModules/LotesDataManagementExtranet/Swagger/index.html?version=public). Dabei dient die Swagger Umgebung primär als zusätzliche Schnittstellendokumentation der API Endpunkte. Eine Schritt-für-Schritt Anleitung zur Nutzung der Swagger Umgebung finden Sie im Abschnitt API Dokumentation (siehe unten).

API Dokumentation 

Um Ihnen die Nutzung der API zur erleichtern, finden Sie hier weiterführende Dokumente: 

Link zur Dokumentation Web API

Link zur JSON Datei 

Link zu den FAQs 

Anleitung zur API Registrierung 

Anleitung zur Client Verwaltung

Anleitung zur Nutzung der Swagger Umgebung

Minimal Working Example (MWE) für Python

Minimal Working Example (MWE) für R

Minimal Working Example (MWE) für MATLAB

Hinweis in eigener Sache: Das Netztransparenz.de Team leistet keinen darüberhinausgehenden Support bei der Programmierung von Skripten.