Verify Migrationsleitfaden

Die folgende Anleitung hilft Ihnen bei der Migration vom veralteten „Verify Legacy“ (V1) zu Verify (V2). Dazu müssen Sie Ihre Endpunkt-URLs aktualisieren, um die neue Version aufzurufen, und Ihre Anwendungseinstellungen ändern. Sie müssen kein Vorregistrierungsformular ausfüllen, um Verify nutzen zu können.

Zusammenfassung

Die Vonage Verify API ist ein Service, der es Entwicklern ermöglicht, eine Zwei-Faktor-Authentifizierung (2FA) zu implementieren, um sich vor Betrug zu schützen und die Authentizität der Benutzer zu gewährleisten. Vonage bietet zwei Versionen dieser API an: Legacy und das aktuelle Verify. Obwohl beide Versionen die gleiche Hauptfunktion erfüllen, gibt es erhebliche Unterschiede in ihren Merkmalen, Funktionalitäten und ihrer Verwendung.

Wesentliche Unterschiede

• Flexibilität und Anpassungsfähigkeit: Verify bietet jetzt eine flexiblere Erstellung von Arbeitsabläufen und erweiterte Anpassungsoptionen, wie z. B. ein funktionsreicheres System zur Verwaltung benutzerdefinierter Vorlagen im Vergleich zu Legacy.
• Kanal-Unterstützung: Verify bietet jetzt zusätzliche Unterstützung für die Verifizierung über verschiedene neue Kanäle wie Silent Auth, RCS, WhatsApp und E-Mail, während Legacy auf SMS und Sprache beschränkt ist.
• Sicherheitsmerkmale: Verify bietet jetzt verbesserte Sicherheitsfunktionen und entspricht den neuesten Standards.
• Schutz vor Betrug: Kunden, die von Verify Legacy zu Verify wechseln, haben Zugriff auf Vonage Fraud Defender Advanced ohne zusätzliche Kosten. Wenden Sie sich an Ihren Account-Betreuer oder kontaktieren Sie Vonage Hilfe-Center um die Aktivierung zu beantragen.
• Fehlerbehandlung: Verify bietet jetzt detailliertere Fehlermeldungen und eine verbesserte Handhabung, wie z.B. erweiterte Ratenbegrenzungs- und automatische Wiederholungsmechanismen.
• API-Entwurf und -Integration: Verify unterstützt sowohl synchrone als auch asynchrone Integrationsmuster.

Vergleich der Merkmale

API-Aufrufe

In Verify wurde ein asynchroner Modus eingeführt, der es Ihnen ermöglicht, Nachrichten und Anrufstatus per Webhook zu empfangen, wobei Sie sowohl Ereignisse (im Falle von whatsapp_interactive) und zusammenfassende Rückrufe. Sie können es auch synchron verwenden mit redirect_url und check_url.

Sie müssen Ihre Webhooks für Verify-Rückrufe im Abschnitt Application des Kunden-Dashboard:

Weitere Dokumentation zu Webhooks finden Sie unter hier.

Endpunkte

Alle Verify-API-Aufrufe müssen aktualisiert werden, um den neuen Endpunkt zu verwenden:

Arbeitsabläufe

Verify bietet Ihnen die Flexibilität, Ihren eigenen Arbeitsablauf zu definieren, im Gegensatz zu den festen Arbeitsabläufen von Legacy. Sie können eine beliebige Kombination von unterstützenden Kanälen Ihrer Wahl im Workflow angeben, maximal jedoch drei Kanäle.

Weitere Dokumentation zu Workflows finden Sie unter hier.

Kanäle

Neue Kanäle sind jetzt in Verify verfügbar:

• SMS
• Sprache (früher TTS in Legacy)
• WhatsApp
• E-Mail
• Stille Authentifizierung
• RCS

Ausführlichere Informationen zu diesen Kanälen finden Sie in der API-Spezifikation.

Spezielle Dokumentation zur stillen Authentifizierung finden Sie unter hier.

Der Voice-Kanal unterstützt die Einrichtung einer benutzerdefinierten CLI über die from Parameter im Workflow. Siehe den Arbeitsablauf Weitere Informationen finden Sie in der Anleitung.

Zusammenfassung Rückrufe

Rückrufe werden an Ihren Webhook mit dem Status des Ereignisses zurückgegeben, entsprechend request_id & Kanal. Die folgenden Sequenzdiagramme zeigen, wie dies bei Verwendung eines einzelnen Kanals oder mehrerer Kanäle in Ihrem Arbeitsablauf funktioniert.

Einzelner Kanal

Mehrere Kanäle

Antwort-Codes

Neben der Änderung der Endpunkte müssen auch Ihre Applications aktualisiert werden, um die Antwortcodes zu verstehen, die bei der Verwendung von Verify empfangen werden:

Antrag auf Stornierung

Schablonen

PSD2-Einhaltung

Antrag auf Überprüfung der Suche

Betrugsmanagement

Sequenzdiagramme verifizieren

Fluss verifizieren

Verify Request mit Summary Callbacks

Sequenzdiagramm für die stille Authentifizierung

Analyse der Payload-Parameter für „Verify Legacy“ im Vergleich zu „Verify“

Verifizierungsanfrage senden

Antrag auf Schecküberprüfung

Antrag auf Überprüfung der Suche

Verifizierungsanfrage abbrechen

Nächsten Verifizierungsprozess auslösen

Benutzerdefinierte Vorlagen

PSD2-Einhaltung

Verify Legacy im Vergleich zu Verify Workflow-Zuordnung

Workflow 1 (Standard)

Muster: SMS → TTS → TTS

Legacy Verify

{
  "api_key": "your_key",
  "api_secret": "your_secret",
  "number": "15555551234",
  "brand": "YourBrand",
  "workflow_id": 1
}

Verify

{
  "brand": "YourBrand",
  "workflow": [
    {"channel": "sms", "to": "15555551234"},
    {"channel": "voice", "to": "15555551234"},
    {"channel": "voice", "to": "15555551234"}
  ]
}

Arbeitsablauf 2

Muster: SMS → SMS → TTS

Legacy Verify

{
  "api_key": "your_key",
  "api_secret": "your_secret",
  "number": "15555551234",
  "brand": "YourBrand",
  "workflow_id": 2
}

Verify

{
  "brand": "YourBrand",
  "workflow": [
    {"channel": "sms", "to": "15555551234"},
    {"channel": "sms", "to": "15555551234"},
    {"channel": "voice", "to": "15555551234"}
  ]
}

Arbeitsablauf 3

Muster: TTS → TTS

Legacy Verify

{
  "api_key": "your_key",
  "api_secret": "your_secret",
  "number": "15555551234",
  "brand": "YourBrand",
  "workflow_id": 3
}

Verify

{
  "brand": "YourBrand",
  "workflow": [
    {"channel": "voice", "to": "15555551234"},
    {"channel": "voice", "to": "15555551234"}
  ]
}

Arbeitsablauf 4

Muster: SMS → SMS

Legacy Verify

{
  "api_key": "your_key",
  "api_secret": "your_secret",
  "number": "15555551234",
  "brand": "YourBrand",
  "workflow_id": 4
}

Verify

{
  "brand": "YourBrand",
  "workflow": [
    {"channel": "sms", "to": "15555551234"},
    {"channel": "sms", "to": "15555551234"}
  ]
}

Arbeitsablauf 5

Muster: SMS → TTS

Legacy Verify

{
  "api_key": "your_key",
  "api_secret": "your_secret",
  "number": "15555551234",
  "brand": "YourBrand",
  "workflow_id": 5
}

Verify

{
  "brand": "YourBrand",
  "workflow": [
    {"channel": "sms", "to": "15555551234"},
    {"channel": "voice", "to": "15555551234"}
  ]
}

Arbeitsablauf 6

Muster: SMS

Legacy Verify

{
  "api_key": "your_key",
  "api_secret": "your_secret",
  "number": "15555551234",
  "brand": "YourBrand",
  "workflow_id": 6
}

Verify

{
  "brand": "YourBrand",
  "workflow": [
    {"channel": "sms", "to": "15555551234"}
  ]
}

Arbeitsablauf 7

Muster: TTS

Legacy Verify

{
  "api_key": "your_key",
  "api_secret": "your_secret",
  "number": "15555551234",
  "brand": "YourBrand",
  "workflow_id": 7
}

Verify

{
  "brand": "YourBrand",
  "workflow": [
    {"channel": "voice", "to": "15555551234"}
  ]
}