Skip to content
Inicio » API SMS Octopush » (2FA) Autenticación de dos factores » OTP / MFA – Código de validación

OTP / MFA – Código de validación

POST
https://api.octopush.com/v1/public/service/otp/validate

Encodage : UTF-8

Autentificación

Los identificadores “api-key” y “api-login” deben añadirse en las cabeceras.

Definición

Permite validar un código OTP generado en Octopush.

Parámetros

NombreTipoDescripción
phone_numberstring(opcional, obligatorio si otp_request_token está ausente) Número de teléfono internacional +XXZZZZZ: “+33611223344”.
codestringCódigo OTP introducido por su visitante/usuario.
otp_request_tokenstring(opcional, obligatorio si falta phone_number) Token de la OTP que se intenta validar. Si falta este valor, Octopush intentará validar el último código enviado a este destinatario.

Ejemplo Curl

curl -X POST \ 
'https://api.octopush.com/v1/public/service/otp/validate' \ 
-H 'Content-Type: application/json' \ 
-H 'api-login: ******@email.org' \ 
-H 'api-key: ************' \ 
-H 'cache-control: no-cache' \ 
-d '
{
  "code": "TRQXSDYNJY",
  "otp_request_token": "otp_111111dab2222222aaa33333"
}'

Copiar y pegar el código

curl -X POST 'https://api.octopush.com/v1/public/service/otp/validate' -H 'Content-Type: application/json' -H 'api-login: ******@email.org' -H 'api-key: ************' -H 'cache-control: no-cache' -d '{"code": "TRQXSDYNJY", "otp_request_token": "otp_111111dab2222222aaa33333"}'

Respuesta Servidor en JSON

Success : 200 Cread0

{
  "code": 0,
  "message": "success"
}

Error : 400 BAD REQUEST

{
  "code": 199,
  "message": "Wrong OTP code.",
  "remaining_number_of_attempts": 3
}

Failure : 400 BAD REQUEST

{
  "code": 194,
  "message": "At least phone number or request token is mandatory."
}

Ejemplos de códigos de retorno

CódigoDescripción
194Al menos el número de teléfono o el token de solicitud es obligatorio.
195cAt least the telephone number or application token is mandatory.
196Se ha alcanzado la cantidad máxima de intentos erróneos.
197Solicitud de OTP expirada.
198Solicitud de OTP no encontrada.
199Código otp erróneo.