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 stabil API-Key instead of flexible OAuth token
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-Adresse hat, können sie den stabilen API-Key anstatt dem flexibleren OAuth nutzen.
Referenz für die Entwicklung in postman GET getdays API-Key
EN: TOC | DE: INHALTSVERZEICHNIS |
English Version
Prerequisites
- LINA
- LINA Third Party API licence
- operator ID registered
- refer to GET getdays API-Key
Security-flexibility
OAuth opens a secured connection from a party with DNS name and even without public fixed IP address. The token chain is repeatedly renewed after first authorization. OAUth is started by a auth call by Third Party without public fixed IP and can be restarted the same way.
For OAuth implement an automatic renewal re-calling ../oauth2/authorize?.. and "login" by relevant users after the token chain was lost unexpectedly
Licencing
To licence an endpoint a manager with sufficient rights needs to login and navigate to Marktplatz.
>> Einstellung >> mein Account >> Marktplatz
In the tile LINA Third-Party-API you can book the desired module.
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 (company).
Usage API-Key
API-Key replaces the need of OAuth to renew bearer token repeatedly. The API-Key parameter is used in GET requests instead.
Example postman
refer to GET getdays API-Key
Deutsche Version
Voraussetzungen
- LINA
- LINA Third Party API Lizenz
- operator ID registriert
- Referenz GET getdays API-Key
Sicherheit-Flexibilität
OAuth öffnet eine sichere Verbindung von Seiten des Drittanbieters mit einem DNS Namen sogar ohne feste öffentliche IP-Adresse und kann auf die selbe Weise erneuert werden. Die token chain wird nach der ersten Autorisierung ständig erneuert.
API-Key ist stabiler. Der API-Key muss auf einen anderen Weg übermittelt werden.
implementieren sie für OAuth eine einen automatische Erneuerung mit dem Wieder-Aufruf von ../oauth2/authorize?.. , wenn sie die token chain unerwartet verloren haben.
Lizensierung
für die Lizensierung eines Endpunktes muss ein Manager mit ausreichend Rechten navigieren zu
Config > Account > Marktplatz
Im Abschitt LINA Third-Party-API buchen Sie das Modul.
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 Software Partners, 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 der Third Party (Firma) übermittelt werden
Nutzung API-Key
Der API-Key ersetzt die ständige Erneuerung der bearer token von OAuth. Stattdessen wird der API-Key genutzt.
Beispiel postman
Referenz GET getdays API-Key