API-Key Authentifizierung ist eine Alternative, um die LINA Third Party API Endpunkte zu nutzen. Wenn der Softwarepartner feste öffentliche IP-Adressen hat, wird der API-Key anstatt dem flexibleren OAuth nutzen.
- mit einem API-Key muss der Geschäftsführer den Client anlegen und den API-key übermitteln - beides von Hand
- mit OAuth2 autorisiert der Geschäftsführer die Anfrage des Partners nur bei der ersten Verbindung
- API-Key für mehrere Läden einer Gruppe /Franchise können im Gruppenmodul lizenziert und angelegt werden
| Benötigtes Modul: | LINA Third-Party-API (Nur die gewünschten APIs) |
| Benötigtes Recht: | GF-Ansicht und "Mein Laden" |
Voreinstellungen
Bevor du die Third-Party-API einrichtest, benötigst du das entsprechende Modul. Gehe dazu bitte zu
- Config
- Account
- Marktplatz.
Dort findest du den Marktplatz, in welchem du deine Module buchen und kündigen kannst. Gehe bitte zur Kachel LINA Third-Party-API. Buche dort die Endpunkte, welche benötigt werden.
Third Party API
Nachdem du das Modul gebucht hast, gehe dazu bitte zu
- Config
- Schnittstellen
- Third Party API
Dort findest du folgende Übersicht vor:
Du siehst hier, welche Module du gebucht hast, sowie dein aktuelles ratelimit. Damit du nicht immer über den Marktplatz das Modul LINA API mehrmals buchen musst, um das ratelimit zu erhöhen, kannst du dies machen, indem du hier den Button betätigst.
Bitte beachte dass du maximal 10 mal das Modul LINA API buchen kannst.API-Keys
Damit du den API-Key erzeugen kannst, gehst du bitte auf den Reiter API-Keys.
Die Felder haben folgende Bedeutungen:
| Name | Die Bezeichnung bzw. der Name. |
| API - Key | Der API-Key. |
| IP - Adressen | Die generierte IP-Adresse. |
| Drittanbieter | Der ausgewählte Drittanbieter. |
| Läuft ab | Das Ablaufdatum, sollte keins angegeben sein, dann steht hier ein -. |
| Rechte (Scopes) | Die Rechte, welche für diesen API-Key erzeugt wurden. |
| Erzeugt von | Der Benutzer, welchen diesen generiert hat. |
| Ebene | Um welche Ebene es sich hierbei handelt; also Betrieb oder Franchise. |
| Aktionen | Hier befindet sich der Button Löschen. |
API-Key erzeugen
Um einen API-Key zu erzeugen, füllst du bitte die Felder aus.
Die Felder werden so erklärt:
| Bezeichnung | Gib hier den gewünschten Namen ein. |
| Drittanbieter wählen | Wähle hier den betreffenden Drittanbieter aus. |
| IP-Adressen | Trage die IP-Adressen hier ein. |
| Rechte (Scopes) | Wähle alle Rechte an, die du dem Drittanbieter gewähren möchtest. |
| Tage gültig | Gib die Anzahl der Tage an, wie lange der API-Key gültig sein soll. |
Klicke anschließend auf API-Key erzeugen, damit dieser gespeichert und in der Übersicht angezeigt wird.
API-Key bearbeiten
Du kannst einen API-Key nicht mehr bearbeiten, sondern nur löschen.
API-Key löschen
Um einen API-Key zu löschen, klickst du bitte auf das gleichnamige Feld hinter dem gewünschten API-Key. Dieser wird dann gelöscht und verschwindet aus der Übersicht.
Erstellen eines Clients für API-Key
für die Erstellung eines Client muss ein Manager mit ausreichend Rechten navigieren zu
>> Config >> Schnittstellen >> Third Party API
Ausfüllen eines Clients
- Bezeichnung
Bezeichnung - Drittanbieter
registrierte Anbieter - IP-Adresse
öffentliche feste IPv4 Adresse des Softwarepartners, an den die Daten gesendet werden, getrennt mit Semikolon. - Rechte (Scopes)
ein oder mehrere Rechte auf Endpunkt(e). Der Drittanbieter kann lesen/schreiben (schreiben = lesen, ändern, löschen) - Gültig für mehrere Tage
Gültigkeit in Tagen, wird keine Zahl eingetragen, bleibt der API-Key zeitlich unendlich gültig
"API-Key erzeugen"
API-Key angelegt
Dieser API-Key muss dem Third Party Schnittstellen Partner Firma übermittelt werden