Über API

Melden Sie Nutzer über API mit benutzerdefinierten Sitzungstoken an.

Die benutzerdefinierte Anmeldung über API ist nur möglich, wenn sie im Backend von Ideanote aktiviert wurde. Bitte kontaktieren Sie uns, wenn Sie diese Authentifizierungsmethode verwenden möchten.

Dieser Artikel beschreibt, wie Sie den Nutzer im Browser über die Ideanote API anmelden. Diese Technik kann verwendet werden, wenn JWT, SAML oder OpenID keine Option ist. Um den Nutzer anzumelden, müssen Sie folgende Schritte ausführen:

Erstellen oder aktualisieren Sie den Nutzer und rufen Sie das Sitzungstoken des Nutzers ab.
Generieren Sie einen Link mit dem Sitzungstoken, mit dem der Nutzer automatisch im Browser angemeldet werden kann.

Nutzer erstellen oder aktualisieren und Sitzungstoken abrufen.

Der folgende JSON-Endpunkt erstellt den Nutzer automatisch, falls er noch nicht existiert, oder aktualisiert ihn, falls er bereits existiert. Der Endpunkt gibt ein Sitzungsobjekt mit einem sessionToken zurück.

POST https://api.ideanote.io/v1/session?fields=kind,user.id,sessionToken

Body-Parameter:

Name	Beschreibung
spaceId	Die ID Ihres Workspace
Art	Für diesen Schlüssel muss immer der Wert CUSTOM festgelegt sein
Daten	Ein Datenobjekt, das die Nutzerdetails beschreibt Name Beschreibung E-Mail (erforderlich) Die E-Mail-Adresse des Nutzers. Wir ermitteln, ob im Workspace bereits ein Nutzer vorhanden ist, indem wir nach einem bestehenden Nutzer mit dieser E-Mail-Adresse suchen. apiToken (erforderlich) Das API-Token eines Besitzerkontos in Ihrem Workspace. Dieses API-Token finden Sie unter /settings/profile in der Ideanote-Webanwendung sub Optionale eindeutige ID, anhand derer ein bestehender Nutzer im Ideanote-Workspace gefunden wird. Wenn sub nicht angegeben ist, wird stattdessen anhand der E-Mail-Adresse nach einem bestehenden Nutzer gesucht. name Der Name des Nutzers avatarUrl Ein Link zu einem Bild, das als Avatarbild für diesen Nutzer verwendet werden soll. team Ein Teamname, zu dem der Nutzer hinzugefügt werden soll. Das Team wird erstellt, falls es noch nicht existiert. locale Die Gebietsschemaeinstellung des Nutzers
Name	Beschreibung
E-Mail (erforderlich)	Die E-Mail-Adresse des Nutzers. Anhand dieser E-Mail-Adresse ermitteln wir, ob bereits ein Nutzer im Workspace vorhanden ist.
apiToken (erforderlich)	Das API-Token eines Besitzerkontos in Ihrem Workspace. Dieses API-Token erhalten Sie unter /settings/profile in der Ideanote-Web-App.
Unter	Optional eindeutige ID, anhand derer ein vorhandener Nutzer im Ideanote-Workspace gefunden wird. Wenn „sub“ nicht angegeben ist, wird stattdessen anhand der E-Mail-Adresse nach einem vorhandenen Nutzer gesucht.
name	Der Name des Nutzers
avatarUrl	Ein Link zu einem Bild, das als Avatarbild für diesen Nutzer verwendet werden soll.
team	Ein Teamname, zu dem der Nutzer hinzugefügt werden soll. Das Team wird erstellt, falls es noch nicht existiert.
Gebietsschema	Die Locale des Nutzers

Beispielanfrage:

Bash

 
curl "https://api.ideanote.io/v1/session?fields=kind,user.id,sessionToken" \
  -H "Content-Type: application/json" \
  -d '{
"spaceId": "b06f0a9a-4813-4515-81a0-29e8f2d193ec",
"kind": "CUSTOM",
"data": {
  "email": "john@doe.com",
  "apiToken": "f2dacce1fe557c7f140a3f7e85",
  "name": "John Doe",
  "avatarUrl": "https://avatars.githubusercontent.com/u/1234"
}
}'

Beispielergebnis:

JSON

 
{  "sessionToken":"41b0d309e0e4a341eccf611f9a70cbb91a6a_164864564232",  "user": ...}

Einen Anmeldelink mit dem Sitzungstoken generieren

Nachdem Sie das sessionToken des Nutzers erhalten haben, können Sie einen Link generieren, über den sich der Nutzer direkt im Browser anmelden kann.

Direkt zur Webapp verlinken

https://{{SUBDOMAIN}}.ideanote.io/login/session/{{SESSION_TOKEN}}

Beispiel:

Automatisch

https://mysubdomain.ideanote.io/login/session/41b0d309e0e4a341eccf611f9a70cbb91a6a_164864564232

Zunächst müssen Sie einen Widget-Link abrufen. Sie finden ihn, indem Sie eine Mission teilen, den Embed-Code bearbeiten und einen Widget-Link für eine „vollständige Seite“ abrufen.

Anschließend müssen Sie die URL um den Abfrageparameter erweitern: &auth.sessionToken={{SESSION_TOKEN}}.

https://idea-widget.ideanote.io/idea-confirmation?config={{WIDGET_ID}}&auth.sessionToken={{SESSION_TOKEN}}