Corvus Hilfe > Api > Yuna > Authentifikation

Authentifikation

Die Api benötigt immer einen sogenannten AuthKey.

Den kann ein Administrator auf dem Webfrontend erstellen, wie genau, kann man unter Api Management nachlesen.

Ohne ein Key wird das System nicht zum Arbeiten bereit sein.

Auth Block

Der Block und sämtliche Informationen bezüglich der Authentifikation befinden sich in einem Block mit dem Namen auth. Dort gibt es aktuell nur den sogenannten key, der dann ausgefüllt werden muss.

Das sieht in etwa so aus:

{
    "auth": {
        "key": "Der AuthKey aus dem Webfrontend wird hier reingeschrieben, der ist relativ lang"
    }
}

Datenfelder

Name	Typ	Default	Beschreibung
`.auth`	Record	-	Der Block für die Authentifikation
`.auth.key`	String	-	Der Key

Eigenarten

Der Auth Block ist der einzige Block, der bei einer Antwort nicht wieder zurückgegeben wird. Auch wenn er falsch sein sollte.

Beispiele

Siehe auch Fehlermeldungen

Fehlender Auth Block

Gesendet:

{}

Empfangen:

{
    "requestStatus": {
        "isError": true,
        "errorMessage": "No valid authKey found"
    }
}

Unbekannter oder nicht aktivierter Key

Gesendet:

{
    "auth": {
        "key": "bla"
    }
}

Empfangen:

{
    "requestStatus": {
        "isError": true,
        "errorMessage": "No valid authKey found"
    }
}

Gültiger Key

Gesendet:

{
    "auth": {
        "key": "123...xyz"
    }
}

Empfangen:

{
    "requestStatus": {
        "isError": true,
        "errorMessage": "Unknown action"
    }
}

Hier kommt natürlich der Fehler, dass keine Action angegeben wurde. Das ist aber OK. Der Key ist gültig.