Mise en œuvre synchrone

Introduction

Ce guide explique comment mettre en œuvre l'authentification silencieuse en utilisant l'approche synchrone, où votre backend attend une réponse directe après avoir redirigé l'utilisateur.

Remarque : si vous utilisez une implémentation synchrone, l'activation des capacités de Verify sur le tableau de bord de l'application est facultatif, car cela ne fait que modifier la capacité à recevoir des webhooks d'état (qui ne sont pas nécessaires pour une implémentation synchrone).

Le diagramme suivant montre les étapes nécessaires à la mise en œuvre de la version synchrone de l'authentification silencieuse :

VonageApp BackendMobile AppVonageApp BackendMobile AppRequest Verification CodeOpen check_url over cellular network using Vonage SDKCheck Verification CodeVerify phone numberPOST v2/verify202 OK (check_url, request_id)Response (check_url)GET check_urlSeveral 302 RedirectsHTTP 200 (request_id, code)Request (request_id, code)POST v2/verify/:request_id (code)HTTP 200 (status: completed)Response (Completed)

Demande de code de vérification

Pour lancer la procédure d'authentification silencieuse, adressez une demande à /verify . Dans l'exemple suivant, le point de terminaison flux de travail spécifie que Verify tentera d'abord d'utiliser l'authentification silencieuse. Si, pour une raison quelconque, la demande échoue, il passera au SMS, puis à l'OTP par appel vocal.

Note : en cas d'utilisation de plusieurs canaux, l'authentification silencieuse doit est le premier canal du flux de travail.

Pour exécuter l'exemple, remplacez les variables suivantes dans le code d'exemple par vos propres valeurs :

Variable Description
JWT Authentifie la demande d'API à l'aide de JWT.
VERIFY_BRAND_NAME Le nom de votre entreprise ou de votre service, indiqué à l'utilisateur dans le message de vérification.
VONAGE_APPLICATION_PRIVATE_KEY_PATH Clé privée de votre application.
VONAGE_APPLICATION_ID ID de l'application de votre demande.
VERIFY_NUMBER Le numéro de téléphone auquel envoyer l'OTP, au format E.164 (par ex, +44111223344).

Rédiger le code

Ajouter ce qui suit à request.sh:

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

Voir la source complète

Exécutez votre code

Enregistrez ce fichier sur votre machine et exécutez-le :

sh request.sh

Si la demande aboutit et que le numéro est soutenuvous recevrez un 200 Ok contenant un request_id et un check_url dans le corps :

{
  "request_id": "c11236f4-00bf-4b89-84ba-88b25df97315",
  "check_url": "https://api.nexmo.com/v2/verify/31eaf23d-b2db-4c42-9d1d-e847e75ab330/silent-auth/redirect"
}

Jusqu'à ce que la demande expire ou soit annulée, check_url peut être utilisée pour effectuer un contrôle d'authentification silencieuse. Après avoir reçu cette réponse, vous devez adresser une demande

GET
à l'adresse suivante check_url de l'appareil mobile que vous essayez d'authentifier.

Important : Les check_url doit être exécutée via une connexion de données mobiles (et non Wi-Fi). La façon recommandée de s'en assurer est d'utiliser le Client SDK de Vonage (iOS ou Android), qui achemine automatiquement la demande par le réseau cellulaire de l'appareil. Voir la page Guide de contournement du Wi-Fi pour l'authentification silencieuse pour plus de détails.

Une fois la requête

GET
effectuée, vous recevrez un certain nombre de messages HTTP 302 redirige en fonction du territoire et de l'opérateur que l'appareil cible utilise :

HTTP/1.1 302 Found
Location: https://eu.api.silentauth.com/phone_check/v0.2/checks/31eaf23d-b2db-4c42-9d1d-e847e75ab330/redirect

En suivant les redirections, vous obtiendrez soit un HTTP 200 ou HTTP 409 selon que la demande est valide ou non. S'il y a un problème avec le réseau, vous obtiendrez une réponse comme celle-ci :

HTTP/1.1 409 CONFLICT
Content-Type: application/json

{
  "title": "Network error",
  "detail": "The Silent Auth request could not be completed due to formatting or the carrier is not supported."
}

Une liste complète des codes d'erreur potentiels est disponible dans la rubrique Spécification de l'API.

Si la demande est valide, vous recevrez un HTTP 200 réponse contenant votre request_id et un code:

{
  "request_id": "c11236f4-00bf-4b89-84ba-88b25df97315",
  "code": "si9sfG"
}

Remarque : pour garantir un contrôle d'authentification sûr et se prémunir contre une éventuelle attaque de l'homme du milieu, il convient de stocker l'original de la carte d'identité de l'utilisateur. request_id et la comparer avec la request_id renvoyés dans la réponse. Si les identifiants ne correspondent pas, la vérification de l'authentification silencieuse doit être interrompue. Voir notre exemple de demande pour un exemple de mise en œuvre d'une mesure d'atténuation de l'attaque.

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

POST
à l'adresse suivante /v2/verify/{request_id} en remplaçant le point d'arrivée {request_id} avec l'identifiant que vous avez reçu lors de l'appel précédent.

Pour exécuter l'exemple, remplacez les variables suivantes dans le code d'exemple par vos propres valeurs :

Variable Description
JWT Authentifie la demande d'API à l'aide de JWT.
VERIFY_REQUEST_ID Les request_id reçue à l'étape précédente.
VONAGE_APPLICATION_PRIVATE_KEY_PATH Clé privée de votre application.
VONAGE_APPLICATION_ID ID de l'application de votre demande.
VERIFY_CODE Le code de vérification reçu par l'utilisateur final

Rédiger le code

Ajouter ce qui suit à check-verification-code.sh:

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'"
  }'

Voir la source complète

Exécutez votre code

Enregistrez ce fichier sur votre machine et exécutez-le :

sh check-verification-code.sh

Note : un code pour un flux de travail d'authentification silencieuse ne peut être vérifié que si une fois.

Si le code est valide, vous recevrez une réponse finale avec le statut completed:

{
   "request_id": "31eaf23d-b2db-4c42-9d1d-e847e75ab330",
   "status": "completed"
}

Ou, en cas d'erreur, vous verrez apparaître le message "Code invalide" :

{
   "title": "Invalid Code",
   "type": "https://www.developer.vonage.com/api-errors/verify#invalid-code",
   "detail": "The code you provided does not match the expected value.",
   "instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}

À ce stade, la vérification de l'authentification silencieuse est terminée.