Installieren Sie die Vivoldi-App von Google Play, um es noch bequemer zu machen.

API für Benutzer-Authentifizierung

Bevor Sie Benutzerdaten abrufen oder Einstellungen über die Vivoldi REST API ändern, sollten Sie ein Zugriffstoken zur sicheren Authentifizierung anfordern.

Die zeitlich begrenzte tokenbasierte Authentifizierung erhöht die Sicherheit des Kontos und schützt API-Anfragen vor externen Bedrohungen.

Fügen Sie das Token im Header X-Access-Token hinzu, um sichere API-Aufrufe durchzuführen.

Diese API ist ab dem Personal-Tarif verfügbar.

POST

/api/user/v1/auth 

{
    "eml": "your@gmail.com"
}

Request Parameters

eml string
E-Mail-Adresse.
Wird verwendet, um Informationen von innerhalb der Organisation hinzugefügten Benutzern im Business-Tarif oder höher abzufragen oder zu ändern.
Wird in den Personal- und Premium-Tarifen ignoriert. 
{
    "code": 0,
    "message": "",
    "result": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Response Parameters

code integer
Antwortcode: 0 = Erfolg, andere Werte = Fehler
message string
Antwortnachricht. Wenn der Code nicht 0 ist, wird eine Fehlermeldung zurückgegeben.
result string
Beim Abrufen oder Aktualisieren von Benutzerinformationen muss es im HTTP-Header unter X-Access-Token hinzugefügt werden.
Das Token ist 1 Minute lang gültig und muss nach Ablauf (durch erneuten Aufruf dieser API) neu ausgestellt werden.

Warum ist ein Authentifizierungstoken erforderlich?

Alle API-Anfragen müssen authentifiziert werden, um die Identität und Berechtigungen zu überprüfen.

Diese API erfüllt folgende Aufgaben:

  • Identifikation des API-Aufrufers
  • Validierung der Benutzerberechtigungen
  • Blockierung unautorisierter Anfragen
  • Verwaltung eines sicheren Sitzungszustands

Wann sollte diese API verwendet werden?

<p> Diese API muss vor dem Zugriff auf alle kontobezogenen Endpunkte aufgerufen werden, z. B. <a href="/url/api/user/retrieve">Retrieve User</a> oder <a href="/url/api/user/update">Update User</a>. </p> <p> Das ausgegebene Token muss bei allen nachfolgenden Anfragen im HTTP-Header als <code>X-Access-Token</code> enthalten sein. Die kurze Gültigkeitsdauer reduziert das Risiko langfristiger Sitzungen und erhöht die Sicherheit. </p>

Bedeutung der 1-Minuten-Gültigkeit

Eine Gültigkeitsdauer von 1 Minute ist ein sicherheitsorientiertes Design.
Selbst wenn ein Token kompromittiert wird, läuft es innerhalb einer Minute automatisch ab und reduziert das Risiko.

Empfohlen wird, das Token unmittelbar vor dem API-Aufruf zu erstellen und sofort zu verwenden.
Das Speichern zur Wiederverwendung kann zu Authentifizierungsfehlern führen.

Zieldefinition und Tarifbedingungen

Ab dem Business-Tarif können Administratoren sich im Namen eines Nutzers authentifizieren, indem sie dessen E-Mail im Parameter eml angeben.

Dies ermöglicht automatisierte Workflows zur Verwaltung und Abfrage von Benutzerdaten innerhalb der Organisation.
Diese API ist nur für Konten mit Personal-Tarif oder höher verfügbar, daher sollte der Tarif vorab geprüft werden.

Wichtige Hinweise

  • Speichern Sie Tokens sicher und stellen Sie sicher, dass sie nicht nach außen gelangen
  • Vermeiden Sie die Verwendung von Tokens im Client, da dies Sicherheitsrisiken birgt
  • Implementieren Sie eine automatische Erneuerung bei Ablauf des Tokens
  • Verwenden Sie die API ausschließlich über HTTPS