Servicio Web de generación y envío de OTP

//Servicio Web de generación y envío de OTP

5. Servicio Web de generación y envío de OTP

Este API es utilizado para solicitar la generación y posterior envió de PIN, según las configuraciones pre-establecidas en el sistema.

El usuario se autentica por medio de usuario y contraseña codificados (en base 64) en el encabezado “Authorization” bajo el estándar “basic” de la siguiente forma:

Authorization = Basic Base64({usuario}:{contraseña})

Bajo este esquema se debe enviar una petición con la siguiente estructura.

URL para consumir el servicio:

https://apitellit.aldeamo.com/otp

ParámetroDescripciónObligatoriedad
configId Identificador generado por Aldeamo, bajo el cual están asociadas todas las configuraciones del servicioObligatorio
otpIdValor alfanumérico que se usa para realizar la asociación con el PIN generado. (Longitud máxima: 20 caracteres)Obligatorio
mobileNúmero telefónico del destino al cual se enviará el PIN Opcional (Requerido si la notificación se debe enviar por SMS o VOZ)
emailCorreo electrónico del destino al cual se enviará el PINOpcional (Requerido si la notificación se debe enviar por SMS o VOZ)

Ejemplo de la petición

  • Content-Type: application/json
  • JSON petición:
{
"configId": "string",
"otpId": "string",
"mobile": "string",
"email": "string"
}

Ejemplo de la respuesta

  • Content-Type: application/json
  • JSON petición:
{
"smsSendingStatus":"ok",
"emailSendingStatus":"ok",
"otpTransactionId":"013ff9a3-4ccf-4125-af33-8e38862680c2"
}
2021-07-14T09:52:36-05:00