Möchtest Du Daten aus LINA einem Drittanbieter bereitstellen, kannst Du jederzeit einen Client in der Third-Party-API für den gewünschten Zweck erzeugen.
Der Partner kann dann die erlaubten Daten aus LINA abholen und weiterverarbeiten
| Benötigtes Modul: | Genutzte Endpunkte |
| Benötigtes Recht: | GF Ansicht / Mein Laden |
Inhaltsverzeichnis
- Was ist eine Third-Party-API?
- Voraussetzung, um eine Third Party API zu erstellen
- Endpunkte und Rechte
Was ist eine Third-Party-API (TPAPI)?
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 definierte Antworten /Daten zurück.
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.
Voraussetzung, um einen TPAPI-Client zu erstellen
a
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.
- LINA muss mit der Kasse verbunden sein (Hierzu kannst Du Dich an Deinen Kassenfachhandelspartner wenden).
- Lizenz für den benötigten Endpunkt (Schnittstelle) in LINA (Hierzu folgst du weiter der Beschreibung).
- Für Webkassen muss zusätzlich noch das Kassenmodul vorbereitet werden (hierzu kannst Du Dich an Deinen Kassenfachhandelspartner wenden).
Datensynchronisation Kassenserver mit LINA Laden einrichten und Kassenmodul vorbereiten - Für den Endpunkt Taxonomie-Import empfehlen wir, das Kassenbuch ebenfalls zu lizenzieren.
Welche Daten benötige ich vom Drittanbieter?
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.
a
Folgende Daten solltest Du Dir vorab vom Drittanbieter einholen:
- Welcher Endpunkt wird benötigt
- Welche Rechte werden benötigt
- Weiterleitungs-URL
Endpunkt lizenzieren
a
Um einen Endpunkt (Schnittstelle) zu lizenzieren, wechselst Du bitte über:
- Config
- Mein Account
- Marktplatz
in Marktplatz.
Auf der rechten Seite kannst Du unter LINA Third-Party-API den gewünschten Endpunkt lizenzieren.
Welchen Endpunkt Du für die Anbindung des Drittanbieters benötigst, erfährst Du vom Drittanbieter.
Um den Endpunkt zu lizenzieren, klickst Du auf den gewünschten Endpunkt und buchst diesen monatlich oder jährlich.
Übersicht vorhandener LINA Lizenzen
Um eine Übersicht deiner Lizenzen in LINA einsehen zu können, gehst du bitte unter
Config > Account > Marktplatz
Auf der rechten Seite befindet sich eine Kachel namens Zusammenfassung LINA Lizenzen.
Die farbliche Hinterlegung sowie die einzelnen Felder haben folgende Bedeutungen:
| Modul | Das gebuchte Modul. |
| Lizenziert durch | Wurde das Modul von der Franchise oder dem Laden gebucht. |
| Anzahl Abonnements | Wie viele Abonnements wurden gebucht. |
| Kosten pro Laufzeit | Was kostet das Modul im Jahr bzw. Monat. |
| Status | Der Status beinhaltet Monats- bzw. Jahresabo aktiv (grün), Abo gekündigt, Restlaufzeit läuft (orange) oder Abo startet am (gelb). |
| Bis | Das Datum, bis wann das Modul aktiv ist. |
Endpunkte lizenzieren oder kündigen
für die Lizenzierung eines Endpunktes muss ein Manager mit ausreichend Rechten navigieren zu
Config > Account > Marktplatz
Im Abschnitt LINA Third-Party-API die angefragten Module buchen. An gleicher Position können Module zum Ende der Mindestlaufzeit vorab gekündigt werden.
ratelimit für POS API "Webkasse" erhöhen /reduzieren
Für die POS API "Webkasse" ist Limit von 100 Datenanfragen pro Laden und 15 Minuten gesetzt.
Dieses ratelimit kann für stark frequentierte Läden erweitert werden durch die mehrfache Lizenzierung von LINA Data POS API (Webkasse). Mit jeder Buchung wird das ratelimit um die gleiche Zahl von Anfragen erweitert bis maximal 1000 Anfragen je Minute.
Config > Account > Marktplatz > Third Party API > POS API
In dem geöffneten Pop-up-Fenster kannst du die Anzahl Abonnements auswählen,
Wähle also die gewünschte Anzahl aus, setze den Haken bei Hiermit bestätige ich die gültigen AGBs und klicke auf Ja, kostenpflichtig buchen. In der Übersicht wird nun angezeigt, dass das Modul mehrfach gebucht wurde.
Zum Kündigen zum Ende der Laufzeit auch hier die Anzahl auswählen. Das Abonnement wird jetzt als gekündigt inklusiver der Restlaufzeit angezeigt.
Zugriff für den Schnittstellenpartner ermöglichen
Für den Zugriff durch das Programm des Schnittstellenpartners muss
- entweder bei API-Key Authentifizierung ein Client manuell erzeugt werden
siehe API-Zugang erstellen bzw. aktivieren. - oder bei Authentifizierung mit OAuth2 nur die Datenübertragung genehmigt werden
siehe OAuth Anmeldung am Endpunkt der Third Party API
Einen Client in der Third-Party-API für OAuth anlegen
a
Um nun einen Client zu erstellen, gehst Du in LINA bitte wie folgt vor:
Wechsele über
- Config
- Schnittstellen
in Third-Party-API.
Anschließend öffnet sich folgende Maske:
Im Reiter Clients kannst Du auf der rechten Seite den API-Client erstellen.
| Bezeichnung | Beschreibung |
| Titel: | Hier kannst du beispielsweise den Namen des Drittanbieters oder der Anwendung angeben. |
| Weiterleitungs-URL: | Gib hier die URL der Schnittstelle des Drittanbieters an. Diese erhältst du ebenfalls von deinem Drittanbieter. |
| Rechte: | Hier legst Du fest, welche Daten übergeben werden dürfen. |
Bitte beachte: Die URL muss im https:// Format angegeben werden. .
Gehe mit der Rechtevergabe vorsichtig um. Der Anbieter der Drittsoftware kann dieses Recht auch ausüben, ohne dass du davon etwas mitbekommst.
Welche Rechte Du mindestens für die Verbindung benötigst, erfährst Du wiederum von deinem Drittanbieter.
Hast Du alle Daten eingegeben, klicke abschließend auf Erzeugen.
Der neue "Client" wird nun links in der Liste angezeigt.
Über das Mülleimer-Icon kannst diesen jederzeit deaktivieren.
Der Geheime Schlüssel ist nur eine begrenzte Zeit gültig. Sollte diese abgelaufen sein, kannst du dem Drittanbieter einen Refresh-Token erstellen und damit die Schnittstelle reaktivieren.
Welche Daten gebe ich an den Drittanbieter weiter?
a
Der Drittanbieter benötigt zur Kommunikation folgende Daten:
Client-ID
Geheimer Schlüssel (Auch Client-Secret genannt)
Beides kannst Du dir einzeln markieren und herauskopieren.
Refresh - Token
a
Refresh-Token sind nur für die Entwicklung von Schnittstellen vorgesehen.
Du kannst für bereits bestehende "Clients" Refresh-Token erzeugen, um die Schnittstelle zu reaktivieren.
Refresh-Token sind nur für die Entwicklung von Schnittstellen vorgesehen.
Hierzu wechselst Du bitte in den Reiter Tokens.
Client: Wähle im Dropdown-Menü den Client aus, dem Du das Refresh-Token zusenden möchtest.
Gültigkeit: Hier kannst die Gültigkeitsdauer des Tokens einstellen.
Rechte: Vergebe hier das Recht für die Daten, auf die der Drittanbieter zugreifen können soll.
Ein Refresh-Token dient lediglich der Reaktivierung. Möchtest Du einem Drittanbieter mehr Rechte einräumen, so musst Du herfür einen neuen Client einstellen.
Endpunkte und Rechte
| Endpunkt | Recht | Wird benötigt für |
| Webkassen - API | Kommunikation mit Webkasse | Stellt die Funktionalität deiner LINA-Kasse für Drittanbieter im Web zur Verfügung. |
| Endpunkt Artikelstammdaten | Artikelstammdaten lesen Artikelstammdaten schreiben | Ermöglicht das Erstellen oder Aktualisieren von Verkaufsartikeln in der Warenwirtschaft. |
| Endpunkt Bewegungsdaten Umsatz | Journaldaten Kasse lesen | Export der Journaldaten des Kassensystems. |
| Endpunkt Personal | Personalstammdaten und Kosten lesen | Export der Personalstammdaten und Personalkosten. |
| Endpunkt BWA | BWAs und SuSas lesen | Export der BWA und SuSa. |
| Taxonomie - Import | Import von Taxonomie-Dateien | Import von DFKA-Taxonomie-Dateien. |