Api Management
Im Api Management werden AuthKeys für den Zugriff auf die API erstellt und verwaltet.
Man benötigt, für den Zugriff auf die Api Yuna, einen sogenannten Auth Key. Der AuthKey muss in dem Api Aufruf mit eingebunden werden. Siehe dazu auch Api Yuna Authentifikation.
Das Frontend erlaubt nun die Verwaltung von diesen AuthKeys.
Wenn es noch keine Keys gibt, sieht es vermutlich in etwa so aus:
Einen neuen Key erstellen
Bei der Erstellung eines neuen Keys wird nach einem Namen und einer Beschreibung gefragt. Der Name sollte kurz und Knackig sein, die Beschreibung sollte irgendwie die Ansprechpartner beinhalten.
In etwa so:
Nachdem man das bestätigt hat, erscheint dieser Key in der Liste, der aber immer erst einmal deaktiviert ist:
Funktionen von vorhandenen Keys
Bearbeiten
Bearbeiten öffnet ein Dialog, wo man den Namen und die Beschreibung anpassen kann.
Aktivieren / Deaktivieren
Damit kann ein Key aktiviert oder deaktiviert werden
Löschen
Das löscht ein Key. Der ist dann weg, und zwar richtig. Sollte mit vorsicht benutzt werden, da der Key nicht wiederherstellbar ist.
Auth anzeigen
Damit wird der AuthKey für die Api angezeigt. Den muss man in das JSON der APi einpflegen. Der ist relativ lang und das ist gut so.
Beispiel:
$ curl -s -d '{"auth":{"key":"7aedf0783a5808da52c21e8dccea3edc682e88770bfd9c9edad5d982b54c70229d27689657895634f98912489dac5a3abdc05dc69346371403a4048349f89305"},"action":"test"}' https://serverName/corvusYuna/apiYuna | jq
{
"action": "test",
"timingInformation": {
"serverReceivedTimestampUtcMs": "1660560371997",
"serverProcessingBeginTimestampUtcMs": "1660560372008",
"serverProcessingEndTimestampUtcMs": "1660560372008"
}
}
$ curl -s -d '{"auth":{"key":"irgendeintippfehlar"},"action":"test"}' https://serverName/corvusYuna/apiYuna | jq
{
"action": "test",
"requestStatus": {
"isError": true,
"errorMessage": "No valid authKey found"
},
"timingInformation": {
"serverReceivedTimestampUtcMs": "1660560410874"
}
}
Zu beachten: No valid authKey found, kommt auch dann, wenn der Key existiert, er aber deaktiviert ist! Siehe dazu auch die Fehlermeldungen der Api