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)?
Unsere LINA Third-Party-API erlaubt der Anwendung einer anderen Firma (sogenannte Drittanbieter, Third-Party) mit LINA zu kommunizieren. Diese können auf Funktionen oder Daten in LINA zugreifen.
Zunächst muss eine sichere Verbindung aufgebaut werden, um die Zugriffsberechtigung zu prüfen und die Daten selbst in einem sicheren Tunnel zu transportieren. Zusätzlich werden die Drittanbieter bei uns registriert (operatorID), um Sicherheit und Funktion zu verbessern.
Zwei verschiedene Authentifizierungsverfahren werden angeboten:
- OAuth token chain für Anfragen von Systemen, kombiniert mit Benutzer-Login
hybrides standardisiertes Verfahren mit Kombination von Maschinen- und Benutzer-Sicherheit - API-Key Authentifizierung, bei dem ein fester Schlüssel Zugriff auf ganz bestimmte Daten erlaubt.
Der anfragende Server braucht eine feste IP-Adresse
Voraussetzung, um einen TPAPI-Client zu erstellen
a
Um einen Third-Party-API Client zu erstellen, müssen verschiedene Voraussetzungen erfüllt 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).
- Für den Endpunkt Taxonomie-Import empfehlen wir dir, das Kassenbuch ebenfalls zu lizenzieren.
Welche Daten benötige ich vom Drittanbieter?
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.
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
Du kannst für bereits bestehende "Clients" Refresh-Token erzeugen, um die Schnittstelle zu reaktivieren.
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. |