Premiers pas avec l'API Verify

Verify vous permet de confirmer le numéro de téléphone d'un utilisateur en envoyant un mot de passe à usage unique (OTP) par le biais de plusieurs canaux tels que les SMS, les e-mails, la voix et WhatsApp. Vous pouvez définir un flux de travail pour contrôler quels canaux sont utilisés et dans quel ordre.

Ce guide vous montre comment appeler l'API Verify de manière synchrone, à l'aide d'un flux de travail qui tente d'abord d'envoyer un SMS, puis passe à un appel vocal en cas d'échec de l'envoi du SMS. Vous apprendrez également à personnaliser la longueur du code OTP et les délais d'attente entre les étapes.

Conditions préalables

Ce guide part du principe que

• Vous avez un Account Vonage. Si ce n'est pas le cas, vous pouvez en créer un gratuitement ici.
• Vous avez cURL installé dans votre système.

Créer une nouvelle application

Pour commencer, nous devons créer une nouvelle application. Cette application contiendra les informations d'identification requises pour authentifier les appels à l'API. Procédez comme suit :

1. Aller à la page Tableau de bord des applications Vonage.
2. Cliquez sur Créer une nouvelle application.
3. Dans le cadre de la Nom entrez un nom pour votre application.
4. Dans le cadre de la Authentification cliquez sur Générer une clé publique et une clé privée pour générer une nouvelle paire de clés. Un fichier de clé privée (.key) sera automatiquement téléchargé. Sauvegardez ce fichier en toute sécurité, car il est nécessaire pour l'authentification de vos appels à l'API.
5. Allez maintenant à la page Capacités section. Puisque nous ne voulons pas recevoir de mises à jour d'état asynchrones, vous pouvez laisser la section Verify désactivée.
6. Enfin, cliquez sur le bouton Générer une nouvelle application pour terminer le processus de création.

Une fois l'application créée, copiez l'identifiant de l'application affiché sur le tableau de bord. Vous aurez besoin de cet identifiant d'application ainsi que du fichier de clés privées pour générer des JWT pour authentifier les demandes d'API.

Verify les utilisateurs finaux avec l'OTP

Pour vérifier les utilisateurs finaux à l'aide d'un mot de passe à usage unique (OTP), suivez ces deux étapes :

1. Demander un code de vérification. L'utilisateur final recevra le code par l'un des canaux spécifiés dans votre appel API.
2. Vérifier le code de vérification fourni. Un deuxième appel à l'API validera le code introduit par l'utilisateur.

Demander un code de vérification

Selon la Spécification APIla première étape consiste à envoyer une requête

curl -X POST "https://api.nexmo.com/v2/verify" \
    -H "Authorization: Bearer $JWT" \
    -H 'Content-Type: application/json' \
    -d $'{
        "brand": "TestVerify",
        "code_length": 5,
        "channel_timeout": 30,
        "workflow": [
        {
            "channel": "sms",
            "to": "'$PHONE_NUMBER'"
        },
        {
            "channel": "voice",
            "to": "'$PHONE_NUMBER'"
        }
    ]
}'

Examinons les en-têtes et le corps de la requête pour mieux comprendre l'appel à l'API.

Si la demande est acceptée, vous recevrez un 200 Ok contenant un request_id dans le corps :

{
   "request_id":"3b4363c9-1234-567a-90ab-c45a134561"
}

Au même moment, l'utilisateur final doit recevoir un SMS contenant un code de vérification à 5 chiffres. Si l'utilisateur n'effectue pas la vérification dans un délai de 30 secondes (selon la définition des channel_timeout), ils recevront automatiquement un appel vocal au cours duquel le code sera lu à haute voix.

Vous aurez besoin des deux request_id et le code saisi par l'utilisateur pour terminer la vérification à l'étape suivante.

Vérifier le code de vérification fourni

Une fois que l'utilisateur final a reçu le code, vous devez envoyer une requête

curl -X POST "https://api.nexmo.com/v2/verify/$VERIFY_REQUEST_ID" \
  -H "Authorization: Bearer $JWT"\
  -H 'Content-Type: application/json' \
  -d $'{
    "code": "'$VERIFY_CODE'"
  }'

En-têtes de requête :

Corps de la demande :

Si la demande est acceptée, vous recevrez un 200 OK réponse indiquant que le processus de vérification a été mené à bien :

{
   "request_id":"3b4363c9-1234-567a-90ab-c45a134561",
   "status":"completed"
}

Conclusion

Dans ce guide, vous avez appris à mettre en œuvre la vérification de l'utilisateur final à l'aide de l'API Verify avec une configuration multicanal : en commençant par SMS et en retombant à Voix si nécessaire.

Les exemples cURL fournis ici le sont uniquement à des fins d'apprentissage. Dans une mise en œuvre réelle, vous devriez intégrer Verify directement dans votre système d'information. backend, en utilisant votre langage de programmation.

Quelle est la prochaine étape ?

Maintenant que vous comprenez le fonctionnement de l'API Verify et la puissance de l'approche multicanal, explorez les différents canaux pris en charge que vous pouvez utiliser dans votre vérification flux de travail.

Améliorez votre processus de vérification en mettant en œuvre Authentification silencieusequi vous permet de vérifier les utilisateurs sur le trafic mobile sans leur demander d'entrer un OTP.

Enfin, n'oubliez pas de vérifier le Spécification APIoù vous trouverez d'autres paramètres utiles pour tirer le meilleur parti de l'API Verify.