Dokumentation: Anmeldung mit dem API-Key
Anmeldung mit API-Key
API-Key erstellen
Zuerst müssen Sie einen API-Key einrichten. Melden Sie sich dazu an der Flowy-Instanz an, bei der Sie sich mit diesem Key anmelden möchten. Öffnen Sie das administrative Frontend, rufen Sie den gewünschten Benutzer auf und erstellen Sie über die entsprechende Schaltfläche einen API-Key. Bitte speichern Sie diesen API-Key in einem Passwort-Safe, da er nur einmal angezeigt wird.
Bitte stellen Sie sicher, dass das Modul user login by api key process auf dieser Flowy-Instanz installiert ist.
Mit dem API-Key anmelden
Zur Anmeldung müssen Sie einen POST-Request an <restTriggerURL>/login senden.
Content-Type: application/json
{"email":"youraddress@example.com","apiKey":"11111111-1111-1111-1111-111111111111"}
Im Erfolgsfall antwortet der Server mit:
{"status":"SUCCESS","statusCode":"OK",
"statusText":"OK",
"data":{"eventId":123456,"body":{"token":"22222222-2222-2222-2222-222222222222"}}}
Sie können nun weitere Flowy-REST-Trigger aufrufen, die eine Authentifizierung erfordern; bitte stellen Sie sicher, dass Sie das erhaltene Token im Format x-auth-token: 22222222-2222-2222-2222-222222222222 als Request-Header mitsenden.
Anmeldung mit Basic Authentication
Der Zugriff auf REST-Trigger ist auch mit Basic Authentication möglich. In diesem Fall muss die entsprechende Einstellung am REST-Trigger aktiviert werden, da sie standardmäßig deaktiviert ist.
Dabei muss die Kombination aus E-Mail-Adresse und API-Key verwendet werden.
Diese Möglichkeit besteht aus Gründen der Abwärtskompatibilität; von ihrer Verwendung wird abgeraten.
Anmeldung mit E-Mail und Passwort
Diese Funktion ermöglicht die Umsetzung von Prozessen, die die integrierte Benutzerverwaltung von Flowy nutzen.
Zur Anmeldung müssen Sie einen POST-Request an <restTriggerURL>/login-by-password senden und die Werte email und password mitliefern.
Bei erfolgreicher Anmeldung wird das Token zurückgegeben und kann für weitere Requests verwendet werden.
Zugriff auf die Benutzer-ID innerhalb eines Prozesses
Ist der anfragende Benutzer authentifiziert, trägt Flowy die Benutzer-ID in das folgende Feld ein:
$.restRequest.userId
Der User-Step stellt die erforderlichen Funktionen bereit, um z. B. die zugeordneten Rollen zu prüfen.