EN:
API-Key authentication is an alternative way to use LINA Third Party API endpoints. If the software partner holds fixed public IP you may use API-Key instead of flexible OAuth2
- with API-Key, the store manager has to create client and transfer API-key - both by hand
- with OAuth2, the store manager only needs to authorize request by partner software on first connect
- for development, refer to postman GET getdays API-Key
DE:
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
- Referenz für die Entwicklung in postman GET getdays API-Key
INHALTSVERZEICHNIS
English Version
Prerequisites
LINA Third Party API licences by the store manager as requested by the interface partner
Endpunkte aktuell und Lizensierung
Setting up a client
To set up a client, a manager with sufficient rights needs to login and navigate to Third Party API.
>> Einstellung >> Schnittstellen >> Third Party API
Edit data
The individual names are explained in more detail below.
Bezeichnung: Free name.
Drittanbieter: Dropdown of registered partners.
IP Adresse: fixed public IP of the software partner, to send data to. This may be a bunch of IPv4 addresses separated by semicolon.
Rechte (Scopes): One or more rights to endpoint(s). Third party may lesen/schreiben (lesen = read only, schreiben = read, modify, delete)
Gültig für mehrere Tage: Duration of access rights in days, if empty the API-Key is valid unlimited in time.
Generate "API-Key erzeugen"
After you have filled in the fields, click on the button API-Key erzeugen.
API-Key generated
The generated API-Key is now displayed. It need need to be transferred to the Third Party interface partner company.
Usage API-Key postman example
The API-Key parameter is used in GET requests.
refer to GET getdays API-Key
Deutsche Version
Voraussetzungen
LINA Third Party API Lizenzen gebucht durch den Geschäftsführer nach Vorgabe des Schnittstellenpartners
Endpunkte aktuell und Lizensierung
Erstellen eines Clients
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
Nutzung API-Key - Postman Beispiel
Der API-Key wird in jedem Aufruf für die Verbindung genutzt.
Referenz GET getdays API-Key