Diese Webseite bietet einen Leitfaden für Nutzer der LINA Third Party API (TPAPI) und Softwareentwickler von Partnerfirmen oder Drittanbietern, um den Zugriff auf LINA-Daten zu verstehen.


Die LINA TPAPI stellt verschiedene Endpunkte zur Verfügung, über die Daten abhängig von der Konfiguration und den Berechtigungen gelesen und/oder geschrieben werden können.


Wir empfehlen für die Softwareentwicklung und -tests die Nutzung eines Demosystems, das von den produktiven Kundensystemen isoliert ist. Nach der Anmeldung kann ein LINA Laden als "Marktplatzteilnehmer" für die Entwicklungen klassifiziert werden, was die Lizenzgebühren aufhebt. 
Falls für den Endpunkt 'POS/Webkasse' eine Kasse benötigt wird, melden Sie sich bitte zu unserer Schulung an. Diese umfasst ein vollständiges Entwicklungs- und Testsystem inklusive einer LINA-Kasse und Artikelstamm.



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 LINA. Es handelt sich um ein Element der LINA-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 LINA 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 LINA Modulen bereit.

Endpunkte müssen in LINA lizenziert werden.


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


Redirect URI / Clients

Für jeden lizenzierten 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 LINA 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 oder per API-Key. Vor dem Zugriff auf die Endpunkte wird mit Token der Zugriff authentifiziert. 

Im Produktivbetrieb beim Kunden authentifiziert dieser einmalig den Zugriff auf den Endpunkt durch Benutzername und Passwort, bzw. durch das Anlegen des Clients und Übergabe des API-Key.

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 LINA 

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


  1. Schnittstelle (Endpunkt) lizenzieren
  2. für Endpunkt 'POS /Webkasse': Datensynchronisation Kassenserver mit LINA Laden einrichten und  Kassenmodul vorbereiten
  3. 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 an einen Drittanbieter senden (Third-Party-API erstellen)


Programmzugriff auf die TP API Schnittstelle


Operator-ID

Mit einer Operator-ID können registrierte Partner definieren, für welche Endpunkte sie Berechtigungen wünschen. Der Endkunde muss nicht den Client von Hand anlegen.


Dokumentation in Postman

Für die Entwicklung mit der TP API ist die vollständige Schnittstelle in in Postman dokumentiert: 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 LINA registriert. Auch für den kostenfreien Testzeitraum müssen Daten vollständig angelegt werden, inklusive der Bezahldaten. Durch Registrierung beim Support der Gastro-MIS (support_at_gastro-mis.de) wird der LINA Laden auf "Demo" gesetzt, sodass die Nutzung über den Testzeitraum hinaus kostenfrei bleibt.


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


Entwicklungs-, Test- und Demosystem Kasse

Für die Entwicklung im Zusammenspiel mit der Kasse wird eine konfigurierte Installation der LINA POS benötigt. Die Daten werden mit dem LINA 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 LINA durch die spezialisierten Fachhandelspartner durchgeführt und an lokale Besonderheiten und Abläufe des 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 Entwicklungssystem mit LINA 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 LINA Laden.

Weiterführende Artikel für Entwickler

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