Anleitung für einen Softwareentwickler um aus den Testzugangsdaten eines GET AG Webservice / API einen Client in seiner Programmiersprache automatisch zu erzeugen.
1. Voraussetzungen
- Installierte Programmiersprache
- Download der OpenAPI-Spezifikation in YAML oder JSON-Format aus Swagger UI der GET AG, deren Link Sie vom Support per E-Mail oder in der Dokumentation erhalten haben - Beispiel Strom Tarif Webservice 2.0
- Zugriff auf Swagger Editor
2. OpenAPI-Spezifikation laden
- Öffne den Swagger Editor
- Lade die heruntergeladene OpenAPI-Spezifikation aus Schritt 1:
- ziehe die Datei per Drag & Drop in den Editor oder
- Klicke auf File → Import File und wähle deine Datei aus oder
- manuelles übertragen der OpenAPI - Spezifikation per copy & paste
3. API-Client generieren
Nachdem die OpenAPI-Spezifikation geladen wurde, gehe zu Generate Client im oberen Menü.
Wähle die gewünschte Programmiersprache aus der Liste (z. B. Python, Java, TypeScript usw.).
Der Download des generierten Clients startet automatisch.
4. API-Client entpacken und nutzen
Entpacke die heruntergeladene ZIP-Datei und integriere die entpackten Daten als neues Projekt in ihrer bevorzugten Entwicklungsumgebung.5. Anpassungen und Erweiterungen
Falls erforderlich, passe den generierten Code an (z. B. Authentifizierung mit den Testzugangsdaten der GET AG aus der E-Mail).
Ergänze eigene Methoden oder Funktionen für spezielle Anforderungen.
Mit diesen Schritten kann schnell und einfach ein API-Client aus einer OpenAPI-Beschreibung erstellt werden!
6. Kontaktformular
Bei Fragen zur Nutzung unserer Webservices / API schreiben sie unserem Support per Kontaktformular: