Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space DA and version BM-4.0
Sv translation
languagefr

Présentation

L'authentification est le point d'entrée de l'utilisation de l'API.

La méthode login permet de récupérer une clef d'authentification (auth-key) grâce à un login et un mot de passe. Cette clef est alors valide et utilisable pour toute la durée de la session d'utilisateur et sert à identifier l'utilisateur pendant les appels d'API suivants.

Il est également possible de créer des clés d'api permanentes dans les paramètres d'utilisateur.

Panel

Sur cette page :

Table of Contents
maxLevel2

Utilisation

Pour les appels en HTTP, la clef est passée via l'en-tête X-BM-ApiKey.

Pour les appels en Java, la clef sert à créer un service-provider pour créer des instances d'api.
Par exemple :

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

https://forge.bluemind.net/staging/doc/openui-models/web-resources/?bm_version=4.1.42252#!/net.bluemind.authentication.api.IAuthentication/post_auth_login

Exemple en HTTP

MéthodeURL
POSThttps://<domain>/api/auth/login?login=<login>

login = identifiant de l'utilisateur

Body

'<password>'

Exemple en Curl

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

Exemple en Java (en utilisant le client généré Bluemind)

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

Präsentation

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

Die Login-Methode ermöglicht mit Hilfe eines Logins und eines Passworts das Abrufen eines Authentifizierungsschlüssels (auth-key). Dieser Schlüssel ist für die Dauer der Benutzersitzung gültig und verwendbar und wird zur Identifizierung des Benutzers bei nachfolgenden API-Aufrufen verwendet.

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

Panel

Auf dieser Seite:

Table of Contents
maxLevel2

Verwendung

Bei HTTP-Aufrufen wird der Schlüssel über den Header X-BM-ApiKey übertragen.

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

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

https://forge.bluemind.net/staging/doc/openui-models/web-resources/?bm_version=4.1.42252#!/net.bluemind.authentication.api.IAuthentication/post_auth_login

Beispiel in HTTP

MethodeURL
POSThttps://<domain>/api/auth/login?login=<login>

login = Benutzeridentifizierung

Body

Passwort

Beispiel in Curl

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

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

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