Rollen für API-Keys erstellen

API-Keys gelten jeweils für definierte Endpunkte.

Wenn Sie einen neuen Endpunkt erstellen, werden die im Portal vorliegenden Endpunkte angezeigt. Anschließend können Sie den bzw. die Endpunkte auswählen, für die der API-Key gültig sein soll.

Beispiel

Der im Screenshot dargestellte Endpunkt "Store Data Retrievers" ist für die beiden "GET"-Endpunkte innerhalb von "Stores" gültig.

Gegebenenfalls benötigen Sie mehrere API-Keys, die für die selben Endpunkte gültig sind. Dies kann zum Beispiel der Fall sein, wenn Sie API-Keys für mehrere Benutzer erstellen möchten.

Für diesen Zweck können Sie Rollen erstellen. Über Rollen können Sie ein Set von API-Endpunkten definieren. Diese werden automatisch übernommen, wenn Sie einen API-Key für die zuvor erstellte Rolle erstellen.

Beispiel

Die beiden "GET"-Endpunkte innerhalb von "Stores" sind vorausgewählt. Es können keine weiteren Endpunkte ausgewählt werden.

Die Rollen, die Sie im Zusammenhang mit API-Keys erstellen, stehen in keinem Zusammenhang mit den Rollen in der Intrexx-Benutzerverwaltung.

Schritt-für-Schritt

Um eine neue Rolle für API-Keys zu erstellen, gehen Sie wie folgt vor:

1. Starten Sie das Modul "Integration".

2. Klicken Sie auf "Application-API" > "API-Keys".

3. Klicken Sie mit der rechten Maustaste auf einen bestehenden API-Key (oder eine bereits bestehende API-Rolle).

   

4. Klicken Sie auf "Neue Rolle erstellen".

   Das Dialogfenster "Neue Rolle erstellen" wird angezeigt.

   

5. Erfassen Sie einen (möglichst sprechenden) Namen.

6. Aktivieren Sie die Endpunkte, die für die Rolle aktiv sein sollen.

7. Klicken Sie auf "OK".

   Sie gelangen zurück auf die Seite "API-Keys".

   Die neu angelegte Rolle wird angezeigt.