API-Key Authentifizierung ist eine Alternative, um die LINA Third-Party-API Endpunkte zu nutzen. Wenn du eine feste öffentliche IP-Adresse hast, kannst du den stabilen API-Key nutzen. Der Bereich OAuth - Client sollte nur für die Entwicklung genutzt 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 unter
- 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 unter
- Config
- Schnittstellen
- Third Party API.
Dort findest du folgende Übersicht vor:
Du siehst hier welche Module du gebucht hast, sowie dein aktuelles Rate Limit. Damit du nicht immer über den Marktplatz das Modul LINA API mehrmals buchen musst, um das Rate-Limit zu erhöhen, kannst du dies machen, in dem 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 eine 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.
OAuth - Clients
Damit du den OAuth - Clients gelangst gehst du bitte auf den entsprechenden Reiter.
Client erzeugen
Um einen Client zu erzeugen füllst du bitte die Felder aus.
Bitte beachte, das dieser Bereich nur für die Entwicklung genutzt werden sollte. Für den produktiven Betrieb sollten Clients über den Drittanbieter erzeugt werden.
Die Felder werden so erklärt:
| Bezeichnung | Gib hier die gewünschte Bezeichnung ein. |
| Drittanbieter | Wähle hier den betreffenden Drittanbieter aus. |
| Redirect - URl | Trage die Redirect-URI hier ein. |
| Rechte | Wähle alle Rechte an, die du dem Drittanbieter gewähren möchtest. |
Klicke anschließend auf Client erzeugen, damit dieser gespeichert und in der Übersicht angezeigt wird.
Client bearbeiten
Du kannst einen OAuth-Client nicht mehr bearbeiten, sondern nur deaktivieren oder löschen.
Client deaktivieren
um den Client zu deaktiveren klickst du bitte auf den entsprechenden Button.
Die Seite lädt neu und der Client ist nun orange hinterlegt.
Refresh Tokens
Du hast die Möglichkeit Refresh Token zu erstellen. Dazu klickst du bitte auf das gleichnamige Feld.
Daraufhin öffnet sich ein Popup-Fenster, in dem du die gewünschte Zeit auswählst, in dem du darauf klickst.
Die Seite verändert sich und darunter erscheint ein manuell erzeugter Refresh Token.
Die Felder haben diese Bedeutungen:
| Token | Hier wird dir der erzeugte Token angezeigt. |
| Rechte (Scopes) | Wähle alle Rechte an, die du dem Drittanbieter gewähren möchtest. |
| Läuft ab | Das Datum, an welchem der Token abläuft. |
| Erstellt durch | Manuell bedeutet das er so erstellt wurde. |
| Gültig | Falls hier ein grüner Haken zu sehen ist, so ist er gültig. Sollte ein rotes Kreuz zu sehen sein natürlich das Gegenteil. |