Diese Seite soll den Nutzern der Amadeus360 Third Party API (TP API) und Softwareentwicklern der Partner /Drittanbieter einen Überblick verschaffen, wie auf Daten in Amadeus360 zugegriffen wird.

Die Schnittstelle Amadeus360 TP API hat verschiedenen Endpunkte, an denen sie je nach Einstellung und Berechtigung Daten lesen und/oder schreiben.


Für die Entwicklung und Test von Software empfehlen wir ein Demosystem getrennt von den Produktiv-Systemen der Kunden. Einen Amadeus360 Laden können sie für die konkrete Entwicklung auf "Demo" setzen lassen, so dass keine Lizenzgebühren anfallen.
Ist zusätzlich eine konfigurierte Kasse notwendig (z.B. Endpunkt 'POS /Webkasse'), buchen sie bitte unsere Schulung. Hier ist ein vollständiges Demosystem mit Amadeus360 Kasse und Artikeln enthalten.


INHALTSVERZEICHNIS


Begriffe in der Third Party API

API

API ist eine Abkürzung für den englischen Ausdruck „Application Programming Interface“ und beschreibt eine „Programmierschnittstelle“ von Amadeus360 . Es handelt sich um ein Element der Amadeus360 Webseite, um Programmen von Dritten (Third Party)  die Anbindung und den Austausch von Daten zu ermöglichen.

Die Programmierschnittstelle ist das technische Gegenstück zum User-Interface. Beim User-Interface gibt der Mensch Daten auf dem Bildschirm ein und erhält Antworten /Daten zurück.
Bei der Programmierschnittstelle stellt das Programm eines Drittanbieters verschiedene genau definierten Anfragen an unsere Webseite mittels https-code und erhält einen Satz von Antworten als formatiertes json-Objekt zurück. Die Anfrage kann auch den Auftrag zum Schreiben von Daten enthalten, die Antwort bestätigt den Erfolg.

Endpunkte

Die Amadeus360 Third Party API (TP API) ist eine Schnittstelle, die als RESTful-API implementiert ist. An einem spezifischen "Endpunkt"  stehen Daten zum Lesen und/oder Schreiben aus den Amadeus360 Modulen bereit.

Endpunkte müssen in Amadeus360 lizensiert werden.


Für den Endpunkt TP API 'POS /Webkasse' ist immer notwendig, dass die Amadeus360 Kasse im Betrieb mit der Amadeus360 synchronisiert und diese konfiguriert ist. Dies richten Sie bitte selbst oder mit Ihrem Fachhandelspartner ein, der den Amadeus Kassenserver im Betrieb betreut.


Redirect URI / Clients

Für jeden lizensierten Endpunkt werden Clients registriert, an die die Daten übertragen werden. Jedem dieser Clients wird als Redirect-URI die Webadresse eingetragen, an die die Daten von Amadeus360 gesendet werden. Unter dieser Adresse ist der Client des Drittanbieters zur Kommunikation erreichbar.


Sicherheit

Der Zugriff auf die TPAPI erfolgt  ausschließlich über das standardisierte OAuth2-Verfahren. Vor dem Zugriff auf die Endpunkte wird mit Token der Zugriff authentifiziert. 

Für den wiederholten Zugriff in der Entwicklung kann ein Refresh-Token in Amadeus360 erzeugt werden. Im Produktivbetrieb beim Kunden authentifiziert dieser einmalig den Zugriff auf den Endpunkt durch Benutzername und Passwort.

Die Daten werden anschließend verschlüsselt übertragen und nur zu dem System, das beim Anlegen der Schnittstelle durch den Ladenbesitzer, erlaubt wurde.


Voraussetzungen in Amadeus360

Für die Nutzung von Schnittstellen, die die TP API nutzen, ist ein Amadeus360 Laden mit Nutzern und Lizenzen erforderlich, in dem die benötigten Endpunkte freigeschaltet und die Clients registriert werden.

  1. Laden in Amadeus 360 registrieren (falls Sie noch keinen Laden in Amadeus 360 haben)
    hier sollten für jede Schnittstelle eigene Nutzer mit eingeschränkten Rechten angelegt werden
  2. Schnittstelle (Endpunkt) lizensieren
  3. für Endpunkt 'POS /Webkasse': Datensynchronisation Amadeus 360 Kassenserver mit dem Amadeus 360 Laden einrichten und  Kassenmodul vorbereiten
  4. Client (API-Zugang) einrichten und berechtigen 


für die genau benötigen Endpunkte und Lizenzen, die Erstellung der Clients und Berechtigungen und evtl. die passende Konfiguration der Kasse prüfen sie bitte die Dokumentation der einzelnen Schnittstelle und die Voraussetzungen auf der Seite des Drittanbieters.


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


Programmzugriff auf die TP API Schnittstelle


Operator-ID

TBD


Dokumentation in Postman

Für die Entwicklung mit der TP API ist die vollständige Schnittstelle in in Postman dokumentiert: Amadeus360 Third-Party-API postman Dokumentation


Entwicklung mit der TP API

Für die sichere Entwicklung mit der TP API wird vom Drittanbieter selbst ein Laden in Amadeus360 registriert. Auch für den kostenfreien Testzeitraum müssen Daten vollständig angelegt werden inklusive der Bezahldaten. Durch Registrierung beim Amadeus360 Support der Gastro-MIS (support_at_gastro-mis.de) wird der Amadeus360 Laden auf "Demo" gesetzt, so dass die Nutzung über den Testzeitraum hinaus kostenfrei bleibt.


Die Gastro-MIS übernimmt keine Verantwortung für die inhaltlich richtige Nutzung der Schnittstellen und Endpunkte.


Demosystem Kasse

Für die Entwicklung im Zusammenspiel mit der Kasse wird eine konfigurierte Installation der Amadeus360 Kasse benötigt. Die Daten werden mit dem Amadeus360 Laden synchronisiert und über die Amadeus SQL Abfragesprache (ASQL) können Bestellungen boniert und Zahlungen "wie im Restaurant" gemacht werden.

Eine vollständig konfigurierte Kasse mit Artikeln, Finanzwegen, Steuern usw. ist eine komplexe Konfiguration, die für die Kunden von Amadeus360 durch die spezialisierten Fachhandelspartner durchgeführt und an lokale Besonderheiten und Abläufe der gastronomischen Geschäfts angepasst wird. Für die Entwicklung von Bestell- und Bezahlsystemen, Warenwirtschaft o.ä. wird ein solches System benötigt. Eine Lizenz für die Installation auf einem lokalen Rechner kann über den Support der Gastro-MIS angefordert werden. Für Installation und gewünschte Konfiguration stehen hier im Handbuch umfangreiche Artikel bereit - ebenso wie für die Programmierung der TP API und ASQL. Ein Support kann hier nicht geleistet werden.


Wir empfehlen für die Programmierung ein vollständiges Demosystem mit Amadeus360 Laden und konfigurierter Kasse. So können sie sich auf die Entwicklung der wesentlichen Komponenten konzentrieren und bekommen Support bei Fragen.
Bitte buchen Sie dazu unsere Schulung im Amadeus360 Laden.

weiterführende Artikel für Entwickler

  1. Übersicht Third Party API
  2. Anmeldung
  3. Zugriff auf Ressourcen
  4. Fehlerbehandlung
  5. Endpunkte zum Datenaustausch