Authentifizierung

Verify API unterstützt zwei Arten der Authentifizierung:

Wann sollten Sie die Basisauthentifizierung oder JWT verwenden?

Sie können beide Möglichkeiten nutzen, aber nicht beide gleichzeitig. Im Allgemeinen, wir empfehlen die Verwendung von JWT Authentifizierung bei der Arbeit mit der Verify-API. Die Basisauthentifizierung ist zwar für den Einstieg einfacher, unterstützt aber nicht die Stille Authentifizierung Kanal.

Grundlegende Authentifizierung

Bei der Basisauthentifizierung werden Ihr API-Schlüssel und Ihr API-Geheimnis in den Kopfzeilen der Anfrage gesendet. Sie finden diese Anmeldeinformationen in Ihrer Dashboard.

Warnung: API-Schlüssel/Geheimnis sind sensibel! Wenn Sie sie öffentlich zugänglich machen (Frontend-Code, GitHub-Repos usw.), kann jeder Ihren Account missbrauchen.

So erstellen Sie den Request Header:

  • Verknüpfen Sie zunächst Ihren API-Schlüssel und Ihr Geheimnis: API_KEY:API_SECRET.
  • Dann, Base64 kodieren das Ergebnis.
  • Schließlich senden Sie es in der Anfrage als Authorization: Basic BASE64_ENCODED_STRING.

Sie können dies innerhalb Ihres Anwendungscodes tun - zum Beispiel in JavaScript:

const credentials = btoa('YOUR_API_KEY:YOUR_API_SECRET');

const response = await fetch('https://api-eu.vonage.com/v2/verify', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Basic ' + credentials
  },
  body: JSON.stringify({ ... })
});

JWT

A JWT (JSON Web Token) ist ein offener Standard (RFC 7519) für die sichere Übermittlung von Informationen zwischen Parteien in Form eines JSON-Objekts. Das Objekt kann optional verschlüsselt und mit einem privaten/öffentlichen Schlüssel signiert werden.

Um ein JWT zu erzeugen, benötigen Sie Ihre application ID und private key, die beide in der Applikation Einstellungen in Ihrem Dashboard.

Warnung: Die Generierung aller JWTs sollte im Backend erfolgen. Halten Sie die Verfallszeit der Token nicht länger als erforderlich.

Es gibt mehrere Möglichkeiten, ein neues JWT zu erzeugen:

vonage auth set --app-id your_application_id --private-key /path/to/your/private.key vonage jwt create

Bitte beachten:

  • Wenn Sie eines der Vonage-Programme verwenden Server-SDKs müssen Sie kein separates JWT erzeugen, da alle SDKs die Erzeugung von JWT-Tokens unterstützen.

  • Wenn Sie das JWT nicht mit einem externen Tool oder einer Bibliothek, wie z. B. den Vonage SDKs, generieren möchten, können Sie Ihre eigene JWT-Generierung implementieren. Die wie man ein JWT erzeugt Blogpost enthält Beispiele in JavaScript und Python, die zeigen, wie man ein JWT ohne externe Abhängigkeiten generiert.

Nach der Generierung sollten die Benutzer in der Lage sein, das Token für den Zugriff auf geschützte Endpunkte zu verwenden. Dies geschieht in der Regel über den Authorization-Header unter Verwendung des Bearer-Schemas:

Authorization: Bearer <JWT>