📖 Darum geht’s
Mit der Rechnungsprinter API kannst du Rechnungen, Gutschriften und zugehörige Daten automatisiert aus pathway abrufen.
Das ist besonders hilfreich, wenn du Dokumente oder Daten in andere Systeme integrieren oder automatisiert weiterverarbeiten möchtest.
Über die API kannst du zum Beispiel:
-
Rechnungen und Gutschriften abrufen
-
PDF-Dokumente herunterladen
-
strukturierte Daten zu Rechnungen erhalten, z. B.
-
Bestellnummer
-
Rechnungsnummer
-
Rechnungsdatum
-
Download-Link zur Rechnung
-
Die API wird pro Shop aktiviert und funktioniert über einen API-Schlüssel, der dein System gegenüber pathway authentifiziert.
⚙️ Schritt-für-Schritt-Anleitung
Schritt 1 – Shop auswählen
-
Logge dich auf der pathway Plattform ein
-
Klicke links im Menü auf Rechnungsprinter & Gehe zu den Einstellungen oben rechts
-
Wähle oben den Shop aus, für den du die API nutzen möchtest
Schritt 2 – API-Schlüssel erstellen
- Öffne den Reiter "Rechnungseinstellungen"
-
Scrolle zum Bereich "Datenabruf über API" & aktiviere dort die API
-
Klicke dazu auf das blaue Plus
-
Der API-Schlüssel wird nun generiert und kann für API-Anfragen verwendet werden.
Beispiel:
ℹ️ Ein API-Schlüssel ist 12 Monate gültig und kann jederzeit erneuert werden.
Nutzung der API: PDF-Datei oder Metadaten
API-Endpunkte verwenden
Wenn du Daten über die API laden möchtest, kannst du den folgenden Endpunkt verwenden:
https://billing.platform.pathway-solutions.de/documents/shopify/{shopId}/order/{orderId}
Dieser Endpunkt liefert die PDF-Datei der Rechnung für die entsprechende Bestellung.
Dabei musst du folgende Parameter ersetzen:
-
{shopId}→ ID deines Shops -
{orderId}→ ID der Bestellung
Dokument-Metadaten statt PDF abrufen (optional)
Wenn du statt der PDF-Datei strukturierte Dokumentdaten abrufen möchtest, kannst du den optionalen Parameter json=true verwenden.
Beispiel:
https://billing.platform.pathway-solutions.de/documents/shopify/{shopId}/order/{orderId}?json=true
In diesem Fall erhältst du z. B.:
-
Rechnungsnummer
-
Bestellnummer
-
Rechnungsdatum
-
Download-Link zur PDF-Rechnung
Diese Variante ist besonders hilfreich, wenn du die Daten in andere Systeme integrieren möchtest.
API-Schlüssel zur Authentifizierung nutzen
Um auf die API zuzugreifen, musst du deinen API-Schlüssel im Request Header mitsenden.
Der Header lautet:
pathway-api-key: DEIN_API_KEY
Damit kann pathway prüfen, ob dein System berechtigt ist, die Daten abzurufen.
ℹ️ Hinweis:
Die technische Integration erfolgt in der Regel durch Entwickler oder dein IT-Team.
💡 Wichtige Hinweise zur Nutzung
🔄 Gültigkeit des API-Schlüssels
Ein API-Schlüssel ist 12 Monate gültig.
Das Ablaufdatum wird dir direkt in den Einstellungen angezeigt.
✅ Mehrere API-Schlüssel gleichzeitig möglich
Du kannst mehrere API-Schlüssel parallel erstellen.
Das ist sinnvoll, wenn ein Schlüssel bald abläuft:
-
Erstelle einen neuen API-Schlüssel
-
Hinterlege ihn in deinem System
-
Sobald dein System den neuen Schlüssel nutzt, kannst du den alten löschen
👉🏼 So vermeidest du Unterbrechungen in deiner Integration.
♾️ Rate Limits
Das Rate Limit beträgt aktuell 120 Abrufe pro Minute
🥳 Du hast es geschafft!
Die Rechnungsprinter API ist jetzt aktiviert und du weißt, wie du einen API-Schlüssel erstellen und verwenden kannst, um Rechnungen und Dokumentdaten automatisiert aus pathway abzurufen.
FAQ – Häufig gestellte Fragen
❓ Was kann ich über die Rechnungsprinter API abrufen?
Über die API kannst du Rechnungen als PDF sowie strukturierte Dokumentdaten wie Bestellnummer, Rechnungsnummer und Download-Link abrufen.
❓ Wie authentifiziere ich mich bei der API?
Du musst den Header pathway-api-key mit deinem API-Schlüssel bei der Anfrage mitsenden.
❓ Wie lange ist ein API-Schlüssel gültig?
Ein API-Schlüssel ist 12 Monate gültig.
❓ Kann ich mehrere API-Schlüssel gleichzeitig nutzen?
Ja. Du kannst mehrere API-Schlüssel parallel erstellen und verwalten.
Support und Kontaktmöglichkeiten
💌 Du brauchst Unterstützung? Unser Support Team ist jederzeit für dich da: