Aplicación sincrónica

Introducción

Esta guía explica cómo implementar la autenticación silenciosa utilizando el enfoque síncrono, donde su backend espera una respuesta directa después de redirigir al usuario.

Nota: si se utiliza una implementación síncrona, la activación de las capacidades de Verify en el panel de control de la aplicación es opcional, ya que esto sólo cambia la capacidad de recibir webhooks de estado (que no son necesarios para una implementación síncrona).

El siguiente diagrama muestra los pasos necesarios para implementar la versión síncrona de la autenticación silenciosa:

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)

Solicitar código de verificación

Para iniciar el proceso de autenticación silenciosa, realice una solicitud a /verify punto final. En el siguiente ejemplo, el flujo de trabajo especifica que Verify intentará utilizar primero la autenticación silenciosa. Si por alguna razón la solicitud falla, se recurrirá a SMS, seguido de una llamada de voz OTP.

Nota: si se utilizan varios canales, la autenticación silenciosa debe sea el primer canal del flujo de trabajo.

Para ejecutar el ejemplo, sustituya las siguientes variables del código de ejemplo por sus propios valores:

Variable Descripción
JWT Autentica la solicitud de API utilizando JWT.
VERIFY_BRAND_NAME El nombre de su empresa o servicio, mostrado al usuario en el mensaje de verificación.
VONAGE_APPLICATION_PRIVATE_KEY_PATH Clave privada de su aplicación.
VONAGE_APPLICATION_ID ID de su solicitud.
VERIFY_NUMBER El número de teléfono al que enviar la OTP, en formato E.164 (p. ej, +44111223344).

Escriba el código

Añada lo siguiente a 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'"
      }
   ]
}'

Ver fuente completa

Ejecute su código

Guarde este archivo en su máquina y ejecútelo:

sh request.sh

Si la solicitud tiene éxito y el número es compatibleRecibirá un 200 Ok que contiene una respuesta request_id y un check_url en el cuerpo:

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

Hasta que la solicitud caduque o se cancele, check_url se puede utilizar para realizar una comprobación de autenticación silenciosa. Al recibir esta respuesta, debe realizar una solicitud

GET
a la carpeta check_url del dispositivo móvil que está intentando autenticar.

Importante: En check_url debe ejecutarse a través de una conexión de datos móviles (no Wi-Fi). La forma recomendada de asegurar esto es usar el Vonage Client SDK (iOS o Android), que enruta automáticamente la solicitud a través de la red celular del dispositivo. Consulta la Guía para evitar la autenticación Wi-Fi silenciosa para más detalles.

Una vez realizada la solicitud

GET
, recibirá una serie de mensajes HTTP 302 redirige en función del territorio y del operador que utilice el dispositivo de destino:

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

Siguiendo los redireccionamientos se producirá un HTTP 200 o HTTP 409 dependiendo de si la solicitud es válida. Si hay un problema con la red, verás una respuesta como esta:

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

Encontrará una lista completa de los posibles códigos de error en la sección Especificación API.

Si la solicitud es válida, recibirá un HTTP 200 que contiene su request_id y un code:

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

Nota: Para garantizar una comprobación de autenticación segura y mitigar un posible ataque de intermediario, almacene el original de request_id y compárelo con el request_id devuelto en la respuesta. Si los ID no coinciden, la comprobación de autenticación silenciosa debe abortarse. Consulte nuestro ejemplo de solicitud para ver un ejemplo de cómo mitigar el ataque.

Comprobar el código de verificación suministrado

Una vez que el usuario final recibe el código, debe enviar una solicitud

POST
a la dirección /v2/verify/{request_id} sustituyendo {request_id} con el ID que recibió en la llamada anterior.

Para ejecutar el ejemplo, sustituya las siguientes variables del código de ejemplo por sus propios valores:

Variable Descripción
JWT Autentica la solicitud de API utilizando JWT.
VERIFY_REQUEST_ID En request_id recibido en el paso anterior.
VONAGE_APPLICATION_PRIVATE_KEY_PATH Clave privada de su aplicación.
VONAGE_APPLICATION_ID ID de su solicitud.
VERIFY_CODE El código de verificación recibido por el usuario final

Escriba el código

Añada lo siguiente a 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'"
  }'

Ver fuente completa

Ejecute su código

Guarde este archivo en su máquina y ejecútelo:

sh check-verification-code.sh

Nota: un código para un flujo de trabajo de autenticación silenciosa sólo puede comprobarse una vez.

Si el código es válido, recibirá una respuesta final con el estado completed:

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

O, si hay un error, verá "Código no válido":

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

En este punto, su verificación de autenticación silenciosa se ha completado.