Leitfaden zur Nutzung der Third-Party-API

INHALTSVERZEICHNIS


Diese Seite soll Ihnen als Entwickler einer Software, die auf Amadeus 360 zugreift einen Überblick verschaffen.

Ihr System kommuniziert dabei mit einem Schnittstelle "Endpunkt" unserer Amadeus 360 Server in einer REST-API. An diesem Endpunkt können sie je nach Einstellung und Funktion Daten lesen und/oder schreiben


Sicherheit

Der Zugriff auf die Amadeus 360 REST-API erfolgt derzeit ausschließlich über das standardisierte OAuth2-Verfahren. Die Daten werden verschlüsselt übertragen und nur zu dem System, das beim Anlegen der Schnittstelle durch den Ladenbesitzer erlaubt wurde.


Voraussetzungen in Amadeus 360

Die verschiedenen Endpunkte benötigen unterschiedliche Schritte zur Vorbereitung, die in den Einzelartikeln genauer beschrieben wird.

Es ist immer notwendig, dass der Amadeus Kassenserver im Betrieb mit der Amadeus 360 Cloud synchronisiert. Dies richten Sie bitte selbst ein oder mit Ihrem Fachhandelspartner, der den Amadeus Kassenserver im Betrieb betreuet.

  1. Laden in Amadeus 360 registrieren (falls Sie noch keinen Laden in Amadeus 360 haben)
  2. Datensynchronisation Amadeus 360 Kassenserver mit dem Amadeus 360 Laden einrichten 
  3. Schnittstelle (Endpunkt) lizensieren
  4. zusätzlich für die Webkasse:  Kassenmodul vorbereiten



Die Beschreibung für den Ladenbesitzer finden Sie in unserem Handbuchartikel Daten aus Amadeus360 an einen Drittanbieter senden (Third-Party-API erstellen) 


Für Entwickler haben gibt es zusätzlich hier eine API-Dokumentation in Postman: Amadeus360 Third-Party-API

Endpunkt erzeugen, Lizenz und Berechtigung

Für jeden Amadeus 360 Laden muss zunächst die passende Schnittstelle lizensiert werden. Die Preise erfragen Sie bitte bei Ihrem Fachhandelspartner oder bei uns.


Amadeus360 / Accountverwaltung  / Lizensierte Module :


  • Artikelstammdaten
    Ermöglicht das Erstellen oder Aktualisieren von Verkaufsartikeln in der Warenwirtschaft inklusive der Rezepturen
  • Bewegungsdaten Umsatz
    Export der Journaldaten des Kassensystems
  • Webkassen - API
    Stellt die Funktionalität Ihrer Amadeus360-Kasse für Drittanbieter im Web zur Verfügung
    Für diese Schnittstelle muss zwingend zusätzlich die Webkasse im Backoffice der Amadeus Kasse registriert werden. Hierfür kontaktieren Sie bitte Ihren Fachhandelspartner
    Kassen konfigurieren


Weiter muss ein Endpunkt mit der entsprechenden Berechtigung durch den Ladenbesitzer erzeugt werden. Dazu wird eingestellt, auf welche Funktionen zugegriffen werden soll und zu welchem Fremd-Server (Internet-Server des programmierenden Dritt-Anbieters) die Datenübertragung erlaubt sein soll. Die Zugangsdaten erstellen Sie, indem Sie wie im Artikel beschrieben  einen Client anlegen und dann an den Drittanbieter weitergeben.


Zugriff auf die Schnittstelle per Code

  1. Übersicht Third Party API

  2. Anmeldung
  3. Zugriff auf Ressourcen
  4. Fehlerbehandlung

  5. Endpunkte Artikelstammdaten (Warenwirtschaft allgemein)
    mit den beiden Untergruppen
    Rezeptur  (inkl aller Verkaufsartikel)
    MEC-Codes und Sparten
  6. Endpunkte Bewegungsdaten Umsatz
  7. Endpunkte Webkasse
  8. Endpunkte Personal