Swagger -UI für die Generator API

REST-Basis: https://erechnungs-validator.de/wp-json/erechnungs-generator/v1

Demo-Zugang (öffentlich)

Wenn der Demo-Modus aktiv ist, können Sie die API hier ohne eigenes Konto ausprobieren. Die angezeigten Zugangsdaten sind nur zum Testen der Schnittstelle gedacht und dürfen nicht produktiv verwendet werden.

Zugangsdaten werden geladen …
Mini-Howto / Crash-Start

1. Token erzeugen

Wählen Sie den Endpunkt POST /auth/token und klicken Sie auf „Try it out“. Senden Sie grant_type=client_credentials sowie die client_id und das client_secret aus dem Demo-Kasten oben (oder Ihre produktiven API-Daten). Nach „Execute“ kopieren Sie den Wert von access_token aus der JSON-Antwort.

2. Token in Swagger hinterlegen

Klicken Sie oben rechts auf „Authorize“, tragen Sie Bearer gefolgt von einem Leerzeichen und dem kopierten access_token ein (oder nur den Token, je nach Swagger-Version), und bestätigen Sie.

3. Rechnung erzeugen

Rufen Sie POST /generate auf, aktivieren Sie „Try it out“ und senden Sie einen JSON-Body mit dem Pflichtfeld e_invoice_type (Wert zugferd oder xrechnung) sowie den übrigen Rechnungsfeldern wie in der API-Dokumentation beschrieben. In der Antwort notieren Sie download_token, download_url und expires_at.

4. Datei abrufen

Rufen Sie GET /download/{token} mit dem Token aus Schritt 3 auf und führen Sie die Anfrage mit demselben Bearer wie zuvor aus. Die Antwort ist die Binärdatei (PDF oder XML); der Download-Token ist nur einmal gültig.

Wichtige Felder in der JSON-Antwort von POST /generate: download_token, download_url, expires_at, filename, content_type — bei Fehlern zusätzlich die Felder für Code und Meldung aus der Fehlerantwort.

API ohne Anmeldung direkt ausprobieren

Die Swagger UI zeigt die Generator-API so, wie sie später auch von Programmen angesprochen wird — nur eben interaktiv im Browser. Sie benötigen dafür keine eigene Software und müssen sich nicht anmelden, solange der Demo-Modus auf dieser Website aktiv ist. In der Oberfläche können Sie den kompletten Erzeugungsablauf ausprobieren: Zuerst holen Sie sich ein Zugriffstoken, dann senden Sie Ihre Rechnungsdaten an den Endpunkt zum Erzeugen, und anschließend laden Sie die fertige Datei genau einmal über den vorgegebenen Download-Link herunter. So wird nachvollziehbar, wie aus strukturierten Daten ein konformes ZUGFeRD-PDF oder eine XRechnung-XML entsteht.

XRechnung und ZUGFeRD per API erzeugen

Welches Format geliefert wird, legen Sie im JSON-Body über das Feld e_invoice_type fest: Der Wert zugferd erzeugt ein ZUGFeRD-PDF mit eingebetteter XML-Rechnung, der Wert xrechnung eine XRechnung als eigenständige XML-Datei. Die API antwortet nicht mit der Binärdatei direkt in diesem Schritt, sondern mit einer klaren JSON-Antwort, in der unter anderem steht, wie und wie lange Sie das Ergebnis abrufen können. Dadurch lässt sich gut einplanen, wie Ihr System später Speicherung, Archiv oder Versand anbindet. Wenn Sie dieselbe Sequenz mehrmals in Swagger durchspielen, gewinnen Sie ein realistisches Bild davon, wie sich die Schnittstelle in bestehende Buchhaltungs- oder ERP-Prozesse einfügt.

Technischer Einstieg für Entwickler

Für Entwicklerinnen und Entwickler sowie für alle, die technisch mitentscheiden, ist die Swagger-Oberfläche ein pragmatischer Startpunkt. Sie sehen dort die HTTP-Methoden und Pfade, die erwarteten Header wie das Bearer-Token nach der Authentifizierung und den Aufbau des Request-Bodies. Die Antworten der API inklusive HTTP-Statuscodes und Fehlertexte werden direkt sichtbar, sodass Sie nachvollziehen können, was bei gültigen Daten passiert und wo Grenzfälle oder Validierungsfehler auftreten. Wenn die Demo aktiv ist, gelten zusätzlich erklärbare Regeln wie Tageslimits oder Wartezeiten zwischen Versuchen; auch das können Sie in der Oberfläche erleben, ohne erst Produktionszugänge zu konfigurieren.

Ideal für Tests und Integration

Sie können die Generator-API also zuerst vollständig „trocken“ in Swagger ausprobieren, bevor Sie bei uns ein dauerhaftes API-Konto beantragen oder Zeit in eine feste Integration investieren. Das verringert das Risiko von Missverständnissen über Schnittstelle und Ablauf und ermöglicht kurze, konkrete Funktionschecks noch in der Evaluierungsphase.

Einordnung und nächste Schritte

Die Swagger UI ist damit ein geeignetes Werkzeug, um die Generator-API praktisch kennenzulernen, mit Beispiel- oder Testdaten erste Durchläufe zu fahren und die spätere Anbindung an eigene Systeme vorzubereiten. Sobald Sie überzeugt sind, dass der Ablauf passt, können Sie dieselben Schritte aus Ihrer Anwendung automatisieren und bei Bedarf ein vertraglich geregeltes Produktivkonto mit eigenen Kontingenten nutzen.

Hinweis: Die Nutzung über die Swagger UI auf dieser Website ist auf Test- und Kennenlernzwecke beschränkt. Für den regelmäßigen oder gewerblichen Produktivbetrieb ist ein separater API-Zugang mit vertraglicher Grundlage, eigenem Client und den vereinbarten Nutzungsgrenzen erforderlich.

Warenkorb