API verifizieren

Mit der Verify-API können Sie bestätigen, dass Sie einen Benutzer unter einer bestimmten Nummer erreichen können, so dass Sie es können:

• Erreichen Sie Ihre Nutzer jederzeit, indem Sie sicherstellen, dass Sie ihre richtige Telefonnummer haben
• Schutz vor Betrug und Spam, indem verhindert wird, dass ein Benutzer mehrere Accounts erstellt
• Hinzufügen einer zusätzlichen Sicherheitsebene, um die Identität eines Nutzers zu bestätigen, wenn dieser bestimmte Aktivitäten durchführen möchte

Wie es funktioniert

Die Verifizierung ist ein zweistufiger Prozess, der zwei API-Aufrufe erfordert:

Antrag auf Verifizierung

1. Ein Nutzer registriert sich über Ihre App oder Website für Ihren Dienst und gibt eine Telefonnummer an.

2. Um zu bestätigen, dass der Benutzer Zugang zu der Nummer hat, mit der er sich registriert hat, führt Ihre Anwendung einen API-Aufruf an die Endpunkt der Überprüfungsanfrage.

3. Die Verify-API generiert einen PIN-Code, der mit einem request_id.

   Unter bestimmten Umständen ist es möglich, einen eigenen PIN-Code anzugeben. Bitte wenden Sie sich an Ihren Account Manager.

4. Die Verify API versucht dann, diese PIN an den Benutzer zu übermitteln. Das Format (SMS oder Text-to-Speech (TTS)) und der Zeitplan für diese Versuche werden durch die von Ihnen gewählten Arbeitsablauf. Wenn der Nutzer Ihre App oder Website nicht erneut besucht, um die erhaltene PIN einzugeben, wird die Verifizierungsanfrage schließlich abgebrochen. Andernfalls müssen Sie die eingegebene Nummer verifizieren, indem Sie eine Verifizierungsprüfung durchführen.

Kontrolle der Verifizierung

5. Der Benutzer erhält die PIN und gibt sie in Ihrer Anwendung ein.

6. Ihre Anwendung führt einen API-Aufruf an die Endpunkt der Verifizierungsprüfung, die in der request_id und die PIN, die der Benutzer eingegeben hat.

7. Die Verify API prüft, ob die eingegebene PIN mit der gesendeten übereinstimmt und gibt das Ergebnis an Ihre Anwendung zurück.

Erste Schritte

Das folgende Beispiel zeigt Ihnen, wie Sie den Verifizierungsprozess starten, indem Sie einen Verifizierungscode an einen Benutzer senden. Wie Sie den vom Benutzer eingegebenen Code validieren und andere Vorgänge durchführen, erfahren Sie im Abschnitt Code-Schnipsel.

curl GET "https://api.nexmo.com/verify/json?api_key=$VONAGE_API_KEY&api_secret=$VONAGE_API_SECRET&number=$VERIFY_NUMBER&brand=AcmeInc"

implementation 'com.vonage:server-sdk-kotlin:2.1.1'

val client = Vonage {
    apiKey(VONAGE_API_KEY)
    apiSecret(VONAGE_API_SECRET)
}

val response = client.verifyLegacy.verify(VERIFY_NUMBER, VERIFY_BRAND_NAME)
if (response.status == VerifyStatus.OK) {
    println("Verification sent. Request ID: ${response.requestId}")
}
else {
    println("Error: ${response.errorText}")
}

apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

implementation 'com.vonage:server-sdk:9.3.1'

VonageClient client = VonageClient.builder()
        .apiKey(VONAGE_API_KEY)
        .apiSecret(VONAGE_API_SECRET)
        .build();

VerifyResponse response = client.getVerifyClient().verify(VERIFY_NUMBER, VERIFY_BRAND_NAME);

if (response.getStatus() == VerifyStatus.OK) {
    System.out.printf("RequestID: %s", response.getRequestId());
}
else {
    System.out.printf("ERROR! %s: %s", response.getStatus(), response.getErrorText());
}

apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

Install-Package Vonage

using System.Threading.Tasks;
using Vonage.Verify;
using Vonage;

var credentials = Credentials.FromApiKeyAndSecret(vonageApiKey, vonageApiSecret);

var request = new VerifyRequest() { Brand = brandName, Number = recipientNumber };

composer require vonage/client

$basic  = new \Vonage\Client\Credentials\Basic(VONAGE_API_KEY, VONAGE_API_SECRET);
$client = new \Vonage\Client(new \Vonage\Client\Credentials\Container($basic));

$request = new \Vonage\Verify\Request(NUMBER, BRAND_NAME);

// choose PIN length (4 or 6)
$request->setCodeLength(4);

// set locale
$request->setCountry('de');

$response = $client->verify()->start($request);

echo "Started verification, `request_id` is " . $response->getRequestId();

pip install vonage python-dotenv

from vonage import Auth, Vonage
from vonage_verify_legacy import StartVerificationResponse, VerifyRequest

client = Vonage(Auth(api_key=VONAGE_API_KEY, api_secret=VONAGE_API_SECRET))

request = VerifyRequest(number=VERIFY_NUMBER, brand='AcmeInc')

response: StartVerificationResponse = client.verify_legacy.start_verification(request)
print(response)

gem install vonage

Leitfäden

• Verify Migrationsleitfaden: Dieser Leitfaden hilft Ihnen bei der Migration von Verify Legacy zu Verify.
• Authentifizierung: Authentifizierung mit Verify API
• Sprachen verifizieren: Die verfügbaren Sprachen für V2 der Verify API
• API-Workflow verifizieren: API-Workflow verifizieren
• Vorlagenverwaltung: So verwenden Sie die Vorlagenverwaltung, um benutzerdefinierte OTP-Nachrichten mit der Vonage Verify API zu versenden
• API-Webhooks verifizieren: Ein Leitfaden zu Webhooks und wie sie mit der Verify API verwendet werden können.
• Stille Authentifizierung: Stille Authentifizierung mit der Vonage Verify API
• Verify Anti-Betrugs-System: Das Betrugsbekämpfungssystem von Verify
• Virtueller Operator für stille Authentifizierung: Eine Einführung in die Verwendung der Virtual Operator-Funktion innerhalb des Vonage Network APIs Playground mit der Silent Authentication
• Netzwerk Entsperren API: Erfahren Sie, was die Vonage Network Unblock API ist und wie man sie verwendet.

Code-Schnipsel

• Abbrechen einer Überprüfungsanfrage
• Aktualisieren einer Vorlage
• Ein Vorlagenfragment aktualisieren
• Ein Vorlagenfragment erstellen
• Ein Vorlagenfragment holen
• Ein Vorlagenfragment löschen
• Eine Vorlage erhalten
• Eine Vorlage erstellen
• Eine Vorlage löschen
• Liste der Vorlagenfragmente
• Listenvorlagen
• Überprüfen eines Verifizierungscodes
• Überprüfungsanfrage mit Stiller Authentifizierung senden
• Überprüfungsanfrage per E-Mail senden
• Überprüfungsanfrage per SMS senden
• Überprüfungsanfrage per Sprache (TTS) senden
• Überprüfungsanfrage per WhatsApp senden
• Überprüfungsanfrage senden (mit Rückfalloption)

Anwendungsfälle

Weitere Lektüre

• API-Referenz verifizieren
• Implementierung der Verify-API mit Node.js
• Verwendung der Verify API in iOS-Anwendungen
• Verwendung der Verify API in Android-Anwendungen