Dokumentation Dynamic Data Service

Was ist der Dynamic Data Service und wie erhält man einen Testzugang?

Der Dynamic Data Service (DDS) ermöglicht es, prozessrelevante Daten unabhängig von einer bestimmten Branche zu erhalten. Der initiale Fokus liegt auf der Zentralisierung der Daten rund um die Energiewende und Sektorenkopplung. 

Beispielhaft werden Daten in Form von Parametern mit Labeln zu dynamischen Stromtarifen, Fernwärme, Elektromobilität oder Börsenpreise bereitgestellt.  

Zu den einzelnen Parametern erhalten Sie Informationen zu: 

• Beschreibung
• Quellen
• Lizenzangaben
• Dokumentation (wenn vorhanden)
• Einheiten
• Regionen 

 

Vorteile des Dynamic Data Service der GET AG

• ein Ansprechpartner für unterschiedlichste Parameter aus diversen Quellen
• Auflistung relevanter Informationen über Vertragsschluss mit Datengeber und dessen Nutzungsbedingungen je Parameter in Dokumentation 
• zentralisierte Bereitstellung von aktuellen Daten für Anwendungsfälle aus diversen Branchen in einer API
• laufende Erweiterung der API um neue Parameter - sprechen Sie uns auch bei eigenen Erweiterungswünschen gern an!
• hohe Skalierbarkeit durch Hosting bei Amazon Web Services (AWS)
• eine deutschsprachige API Doku auch bei fremdsprachigen Datenquellen
• revisionssichere Daten inkl. Quellenverzeichnis
• relevante Industriekennzahlen der GET AG
• unkomplizierte Beantragung eines kostenlosen Testzugangs über das nachfolgende Kontaktformular

 

Kontaktformular Zugangsdaten

Mit dem Kontaktformular können sie einen Zugang zum Stagesystem des "Dynamic Data Service" anfordern: 

 

SwaggerUI - Authentifizierung und Schritt-für-Schritt Anleitung

Zugangsdaten 

Mit obigem Kontaktformular erhalten sie die Zugangsdaten zur Basis Authentifizierung des Stage-Systems des Dynamic Data Service.

URL des Dynamic Data Service 

Stage-System: https://stage.dds-client.getag-cloud.com/swagger-ui/index.html 

Produktivsystem: https://dds-client.getag-cloud.com/swagger-ui/index.html

Basis Authentifizierung

Durch Eingabe der bereitgestellten Zugangsdaten loggen Sie sich in die Swagger-Umgebung ein.

Client Authentifizierung

Der DDS-Client-Login ist notwendig, um sich im Dynamic Data Service zu authentifizieren.

Dazu sind die Eingabefelder bei "Read API with Basic-Auth" mit den erhaltenen Zugangsdaten zu verwenden, welche Sie auch für den Schritt Basis Authentifizierung. genutzt haben.

Sie gehen in dieser Schrittfolge vor:

1. Schritt  - Authorize

2. Schritt - Client Authentifizierung "Read API with Basic-Auth"

Nach Eingabe der Zugangsdaten klick auf Button "Authorize".

3. Schritt - Try it Out

4. Schritt - Execute mit Testresponse zu "listCommands"

Nach erfolgreicher Authentifikation (Anzeige Code 200) können alle Methoden angesprochen werden. 

Die Methoden und verschiedenen Parameter des Dynamic Data Service werden in den nächsten Abschnitten und Unterseiten beschrieben.

Dokumentation Client Methoden des Dynamic Data Service

• userInfo - Methode zur Ausgabe Client bezogener Information der Userin
  • GET /jsonapi/dds/read/userInfo
  • Die Methode bietet einen Überblick über die Information zur eingeloggten Userin, wie z.B. Rechte und Rollen. Sie ist für die weitere Nutzung des DDS Client nicht von Bedeutung und hat einen rein informatorischen Wert.
• listCommands - Methode zur Auflistung der verfügbaren Abfragen
  • GET /jsonapi/dds/read/listCommands
  • Durch das Ausführen der listCommands wird eine Übersicht aller verfügbaren Abfragemethoden (query) ausgegeben, um Information aus dem DDS zu generieren.
• query - Methode zur Abfrage des gewünschten Aufrufs
  • GET /jsonapi/dds/read/getData/{query}
  • Mit Hilfe der query-Methode können sämtliche Abfragen aus der listCommands an den DDS Client übergeben werden.
  • query-Eingabefeld (Pflichtangabe)
    • Übergabe der gewünschten Methode aus listCommands
      
    • Beispiel: query -> listAllParameter
      
  • params-Eingabefeld (Pflichtangabe, ausgenommen bei query -> listAllParameter)
    • Übergabe des benötigten Parameters, welcher für die Abfrage notwendig ist -  z.B. label

• • • Beispiel: query -> allValueParameter_byLabel
      

Dokumentation der verfügbaren Querys 

query - listAllParameter

• Auflistung aller im DDS verfügbaren Parameter

query - allValueParameter_All

• Ausgabe aller im DDS verfügbaren Parameter, inklusive aller dazu erfassten Werte

query - allValueParameter_byLabel

• Ausgabe aller im DDS verfügbaren Werte zum übergebenen Parameter

query - filteredValueParameter_byLabel

• Ausgabe einer gefilterten Menge an Werten zum übergebenen Parameter
  

query - parameterValueStructure_byLabel

• Ausgabe der JSON-Struktur zum übergebenen Parameter, in der die Werte des Parameters ausgegeben werden (z.B. zum besseren Verständnis der Datenstruktur)