Zum Hauptinhalt gehen

Authentifizierung

Die Authentifizierung ist der Einstiegspunkt für die Nutzung der API.

Die Methode login ermöglicht es, einen Authentifizierungsschlüssel (auth-key) anhand eines Logins und eines Passworts zu erhalten. Dieser Schlüssel ist dann für die gesamte Dauer der Benutzersitzung gültig und verwendbar und dient zur Identifizierung des Benutzers während nachfolgender API-Aufrufe.

Es ist auch möglich, dauerhafte API-Schlüssel in den Benutzereinstellungen zu erstellen.

Nutzung​

Bei HTTP-Anfragen wird der Schlüssel über den Header X-BM-ApiKey übergeben.

Bei Java-Aufrufen wird der Schlüssel verwendet, um einen Service-Provider zu erstellen, der API-Instanzen erzeugt. Zum Beispiel :

IServiceProvider serviceProvider = ClientSideServiceProvider.getProvider(server, resp.authKey);

https://pkg.bluemind.net/apidoc/openui-models/web-resources/?bm_version=4.9.2940#!/net.bluemind.authentication.api.IAuthentication/post_auth_login :

Beispiel in HTTP​

  • Methode : POST
  • URL : https://<domain.lan>/api/auth/login?login=<Benutzerkennung>
  • BODY : "Passwort"

Beispiel für Curl​

curl -X POST -k --header 'Content-Type: application/json' --header 'Accept: application/json' -d '"password"' 'https://<domaine>/api/auth/login?login=<login@domain>'

Beispiel in Java (unter Verwendung des generierten Clients Bluemind)​

String serverUrl = "https://<domain>";
LoginResponse resp = ClientSideServiceProvider.getProvider(serverUrl, null).instance(IAuthentication.class).login(<login>, <password>, "");
IServiceProvider serviceProvider = ClientSideServiceProvider.getProvider(server, resp.authKey);

Letztes Update