Es ist relativ einfach, AmadeusBon als API für digitale Belege zu nutzen. AmadeusBon nimmt die Rechnungsdaten im Json-Format (Standard für elektronische Rechnung) an und generiert daraus ein PDF mit der JSON-Datei im Anhang.
Bitte beachten Sie, dass die AmadeusBon-API nur bis 31.12.2020 kostenfrei nutzbar ist. Ab 01.01.2021 wird die Nutzung der AmadeusBon-API für Endkunden kostenplichtig.
Als Erstes müssen Sie (und später Ihre Kunden) einen Betrieb in AmadeusBon registrieren.
Ist dies erledigt, benötigen Sie für die nächsten Schritte den API-Key dieses Betriebes.
Die AmadeusBon - API umfasst zwei Aufrufe:
- https://login.amadeus360.de/extern/ebonapi/ping Über diesen Aufruf können Sie feststellen, ob AmadeusBon überhaupt erreichbar ist.
- https://login.amadeus360.de/extern/ebonapi/receipt Über diesen Aufruf, werden die Rechnungsdaten hochgeladen.
Für beide Endpunkte gilt, dass der API-Key des Betriebes, den man ansprechen möchte, als Bearer-Token mitgesendet werden muss. Als einfachste Möglichkeit, die AmadeusBon-API zu testen verwenden wir Postman:
Bei erfolgreichem Aufruf des "ping"-Endpunktes erhalten Sie ein Json-Objekt zurück:
{ "message": "Successfully authenticated" }
Sollte der API-Key falsch sein, erhalten Sie
{ "message": "Not authenticated" }
Rechnung an AmadeusBon senden
Um eine Rechnung an AmadeusBon zu senden, muss der Json-Strig der Rechnung, zunächst per gzip komprimiert werden und dann base64-codiert im Body des Requests geschickt werden.
AmadeusBon validiert das Json anhand des angehängten Schemas. Schlägt die Validierung fehlt, erhalten Sie den ersten Fehler zurück.
Im Erfolgsfall erhalten Sie ein Json-Objekt zurück:
{ "uuid": "f5cf1c34c15a5f7e7fa9cee23c338bf3064cf8015ba65edc25a99b1ab2405bdb", "link": "http://amadeus360.vm/extern/ebon/index/uuid/f5cf1c34c15a5f7e7fa9cee23c338bf3064cf8015ba65edc25a99b1ab2405bdb", "message": "Receipt was created successfully" }
Enthalten sind die uuid der Rechnung, der Link, unter dem die Rechnung abgerufen werden kann, sowie eine Nachricht über den erfolgreichen Upload.
AmadeusBon prüft Ihren Upload auf mehrfachen Upload. Falls dies erkannt wird, bekommen Sie die folgende Antwort:
{ "uuid": "f5cf1c34c15a5f7e7fa9cee23c338bf3064cf8015ba65edc25a99b1ab2405bdb", "link": "http://amadeus360.vm/extern/ebon/index/uuid/f5cf1c34c15a5f7e7fa9cee23c338bf3064cf8015ba65edc25a99b1ab2405bdb", "message": "The receipt was already created" }