Receipt API
Die API hinter dem digitalen Beleg.
Die Middleware signiert Belege an der Kasse. Die Receipt API liefert sie danach aus: Sie stellen jeden Beleg im gewünschten Format dar, teilen ihn über mehrere Kanäle und ordnen Transaktionen aus Ihrer App zu.
Drei Zugriffsmodi
Wählen Sie Ihre Tiefe
- Endkunden – Dem Link folgen, ohne Einrichtungkeine Authentifizierung
- Apps von Drittanbietern – Die meisten Endpunkte, ein zusätzlicher HeaderAppId
- Rohdaten – Vollständige Belegdaten für Ihr BackendAppId + AppSecret
- Belege pro Tag
- Millionen
- Zugriffsmodi
- 3
- Belegdarstellung, für alle
- € 0
- rein, HTML oder JSON raus
- JSON
AUTHENTIFIZIERUNG
Drei Zugriffsmodi. Der erste braucht nichts.
Der Zugriff wächst mit Ihrem Anwendungsfall. Kunden brauchen nichts. Apps ergänzen eine Kennung. Rohdaten erfordern Zugangsdaten.
| Modus | Authentifizierung | Das erhalten Sie | Markierung des Belegs |
|---|---|---|---|
| Endkunde | Keine | Belegdarstellung über die receipt-url | Wird bei jedem Aufruf als akzeptiert und angesehen markiert |
| App eines Drittanbieters | AppId als Header oder Query-Parameter, angefordert über das fiskaltrust.Portal | Die meisten Endpunkte, einschließlich Darstellungen im App-Kontext | Nicht markiert, Ihre App-Aufrufe bleiben aus der Händler-Nachverfolgung heraus |
| Rohdaten | AppId + AppSecret | Vollständige Belegdaten für die Verarbeitung im Backend | Nicht markiert |
DARSTELLEN
Ein Beleg, HTML oder JSON.
Rufen Sie jeden Beleg über seine global eindeutige Kennung ab und stellen Sie die Version dar, die Ihr Kanal braucht. Die Antwort liefert pro Anfrage HTML zur Anzeige oder JSON für Ihre eigene Darstellung.
- receipt-url
- Jeder digitale Beleg trägt einen Link. Das Öffnen des Links zeigt die Belegdarstellung, kostenlos, für alle.
- accepted / viewed
- Jeder Kundenaufruf markiert den Beleg als akzeptiert und angesehen. Händler können nachvollziehen, wann Kunden ihre Belege erhalten haben.
- AppId-Kontext
- Aufrufe mit einer AppId lassen die Markierung aus. Ihre App stellt Belege dar, ohne die Händler-Nachverfolgung zu berühren.
TEILEN UND ZUORDNEN
Millionen Belege, offen für Ihre App.
Treueprogramme, Spesen-Tools und Banking-Apps verbinden sich mit den Belegen, die fiskaltrust täglich verarbeitet. Teilen bringt Belege über Kanäle hinweg. Zuordnen verknüpft Transaktionen mit Ihren Datensätzen.
Teilen
Übergeben Sie Belege über dieselbe Schnittstelle an Wallets, E-Mail, Apps und andere Kanäle.
Zuordnen
Verknüpfen Sie Kartentransaktionen und App-Datensätze mit den zugrunde liegenden Belegdaten.
Eine AppId zum Start
Fordern Sie Ihre AppId im fiskaltrust.Portal an und rufen Sie die meisten Endpunkte noch am selben Tag auf.
Eine Kennung rein, der Beleg raus. HTML oder JSON.
DESIGN UND VERSIONIERUNG
RESTful, vorhersehbar, versioniert.
Die Receipt API folgt gängigen REST-Konventionen, damit Ihr Team ohne Einarbeitung starten kann.
JSON rein
Die API akzeptiert bei jedem Aufruf JSON-Daten.Standard-Statuscodes
Antworten nutzen Standard-HTTP-Statuscodes, kein eigenes Fehlerschema.Semantische Versionierung
Breaking Changes gibt es nur in Hauptversionen. Aufrufe ohne Version erhalten die neueste.Version in der URL
Legen Sie eine Version ausdrücklich in der URL fest, sobald weitere Versionen erscheinen.
Dokumentation und Beispiele stehen unter der EUPL-Lizenz, im Einklang mit der Open-Source-Middleware. Lesen Sie sie, forken Sie sie, bauen Sie darauf auf.
SELF-SERVICE
Alles, was Sie vor einem Gespräch brauchen.
Beurteilen Sie Machbarkeit und Eignung nach Ihren eigenen Kriterien. Der Stack ist dokumentiert, öffentlich und schon heute testbar.
Dokumentation
Dokumentation lesenVollständige API-Referenz, Integrationsleitfäden und Fehlersemantik auf Englisch unter docs.fiskaltrust.eu.
GitHub
Repos ansehenMiddleware-Quellcode, Launcher, Devkit und Demo-Implementierungen, offen einsehbar.
Sandbox
Zugang erhaltenEine nahezu vollständige Kopie des Live-Systems. Signieren Sie Testbelege ohne rechtliche Verpflichtung.
Academy
Programm ansehenStrukturiertes Onboarding für Ihr Team, von der ersten Anfrage bis zum zertifizierten Rollout.
FAQ
Vor Ihrem ersten Aufruf.
Kurze Antworten, die Schemata stehen in der Referenz.
Woher kommen die Belege?
Die Middleware erstellt und signiert Belege an der Kasse über die POS System API. Die Receipt API liefert diese Belege danach aus. Eine Middleware-Integration kommt zuerst.
Wo erhalte ich eine AppId?
Fordern Sie die AppId über das fiskaltrust.Portal an. Fügen Sie die AppId bei jeder Anfrage als Header oder Query-Parameter hinzu.
Wie komme ich an Rohdaten von Belegen?
Anfragen nach Rohdaten authentifizieren sich mit AppId und AppSecret. Diese Zugangsdaten gibt es nur auf Einladung, schreiben Sie mit Ihrem Anwendungsfall an hello@fiskaltrust.eu.
Markiert die Darstellung eines Belegs etwas?
Kundenaufrufe markieren den Beleg als akzeptiert und angesehen und liefern dem Händler so Nachverfolgungsinformationen. Aufrufe mit einer AppId lassen die Markierung aus.
Ist die Darstellung kostenlos?
Ja. Jeder folgt der receipt-url kostenlos. App-Integrationen und der Zugriff auf Rohdaten folgen den oben beschriebenen Zugriffsmodi.
Wie stabil ist die Schnittstelle?
Semantische Versionierung. Nur Hauptversionen enthalten Breaking Changes, ergänzte Felder verändern bestehende Modelle nie. Aufrufe ohne Version erhalten die neueste Version.
Der receipt-url folgen. Dann die Referenz lesen.
Der Beispielbeleg in der Referenz zeigt die Darstellung live. Die Referenz enthält jeden Endpunkt, Modus und jedes Modell.
Sie sprechen mit echten Menschen