Guide de migration Verify

Le guide suivant vous aidera à migrer de Verify L'héritage à Verify. Pour ce faire, vous devez mettre à jour les URL de vos points d'extrémité pour appeler la nouvelle version et modifier les paramètres de votre application ; vous n'êtes pas tenu de remplir un formulaire de préinscription pour commencer à utiliser Verify.

Résumé

L'API Verify de Vonage est un service qui permet aux développeurs de mettre en œuvre l'authentification à deux facteurs (2FA) pour se protéger contre la fraude et garantir l'authenticité de l'utilisateur. Vonage propose deux versions de cette API : Legacy et l'actuelle Verify. Bien que les deux versions remplissent la même fonction principale, il existe des différences significatives dans leurs caractéristiques, leurs fonctionnalités et leur utilisation. dans leurs caractéristiques, leurs fonctionnalités et leur utilisation.

Différences majeures

• Flexibilité et personnalisation: Verify offre désormais une création de flux de travail plus flexible et des options de personnalisation améliorées, telles qu'un système de gestion des modèles personnalisés plus riche en fonctionnalités par rapport à Legacy.
• Soutien à la chaîne: Verify inclut désormais une prise en charge supplémentaire de la vérification via divers nouveaux canaux tels que Silent Auth, RCS, WhatsApp et Email, alors que Legacy est limité aux SMS et à la voix.
• Caractéristiques de sécurité: Verify comprend désormais des fonctions de sécurité améliorées et une conformité aux normes les plus récentes.
• Protection contre la fraude: Les clients qui migrent de Verify Legacy vers la nouvelle API de Verify bénéficient d'une protection et d'un accès à . Vonage Fraud Defender Advanced sans frais supplémentaires.
• Gestion des erreurs: Verify fournit désormais des messages d'erreur plus détaillés et un traitement amélioré, comme ainsi que des mécanismes plus avancés de limitation de débit et de réessai automatique.
• Conception et intégration de l'API: Verify prend en charge les modèles d'intégration synchrones et asynchrones.

Comparaison des caractéristiques

Appels de l'API

Le mode asynchrone a été introduit dans Verify, ce qui vous permet de recevoir des messages et des statuts d'appel par webhook, en recevant à la fois l'événement (dans le cas de whatsapp_interactive) et les rappels de résumé. Vous pouvez également l'utiliser de manière synchrone avec redirect_url et check_url.

Vous devez configurer vos webhooks pour les rappels Verify dans la section Application de l'onglet Tableau de bord du client:

Une documentation complémentaire sur les webhooks est disponible à l'adresse suivante ici.

Points finaux

Tous les appels à l'API Verify doivent être mis à jour pour utiliser le nouveau point de terminaison :

Flux de travail

Verify vous offre la possibilité de définir votre propre flux de travail, par opposition aux flux de travail fixes de Legacy. Vous pouvez spécifier n'importe quelle combinaison de canaux de support de votre choix dans le flux de travail, jusqu'à un maximum de trois canaux.

D'autres documents sur les flux de travail sont disponibles ici.

Canaux

De nouvelles chaînes sont désormais disponibles dans Verify :

• SMS
• Voix (anciennement TTS dans Legacy)
• WhatsApp
• Courriel
• Authentification silencieuse
• RCS

Pour plus d'informations sur ces canaux, voir le site web de la Commission européenne. Spécification de l'API.

La documentation spécifique à l'authentification silencieuse est disponible ici.

Rappels récapitulatifs

Les rappels sont renvoyés à votre webhook avec l'état de l'événement, correspondant à l'état de l'événement. request_id & canal. Les diagrammes de séquence suivants montrent comment cela fonctionne lors de l'utilisation d'un seul canal ou de plusieurs canaux dans votre flux de travail.

Canal unique

Canaux multiples

Codes de réponse

Outre la modification de vos points de terminaison, vos applications doivent également être mises à jour pour comprendre les codes de réponse reçus lors de l'utilisation de Verify :

Demande d'annulation

Modèles

Conformité à la DSP2

Demande de vérification de la recherche

Gestion de la fraude

Verify Sequence Diagrams (diagrammes de séquence)

Verify Flow

Verify Request with Summary Callbacks (Vérifier la demande avec des rappels de synthèse)

Diagramme de séquence d'authentification silencieuse

Verify Analyse des paramètres de la charge utile pour V1 vs V2

Envoyer une demande de vérification

Demande de vérification de chèque

Demande de vérification de la recherche

Annuler la demande de vérification

Déclencher le processus de vérification suivant

Modèles personnalisés

Conformité à la DSP2

Mappage des flux de travail de Verify V1 et de Verify V2

Flux de travail 1 (par défaut)

Modèle : SMS → TTS → TTS

Verify V1

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

Verify V2

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

Flux de travail 2

Modèle : SMS → SMS → TTS

Verify V1

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

Verify V2

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

Flux de travail 3

Modèle : TTS → TTS

Verify V1

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

Verify V2

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

Flux de travail 4

Modèle : SMS → SMS

Verify V1

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

Verify V2

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

Flux de travail 5

Modèle : SMS → TTS

Verify V1

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

Verify V2

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

Workflow 6

Modèle : SMS

Verify V1

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

Verify V2

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

Workflow 7

Modèle : TTS

Verify V1

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

Verify V2

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