Manual de Integración – OTP (MAN-PP-03-12 ) #

Contenido

1. Control de Cambios. 2
2. Introducción. 3
3. Generación y envío de PIN.. 4
4. Validación de PIN.. 6

1.           Control de Cambios #

2.           Introducción #

Aldeamo está en la capacidad de suministrar infraestructura, servicios, interfaz, protocolos y recursos necesarios para el envío de códigos de autenticación de un solo uso mediante una integración a través tecnologías (API) detalladas en el presente manual.

Aldeamo cuenta con integraciones de diferentes servicios de comunicación, principalmente operadores móviles (SMS, Flash SMS), proveedores de servicios de correo electrónico (Gmail, Hotmail, Yahoo etc.), mensajería de Voz y proveedores de servicios de mensajería OTP (WhatsApp, Facebook Messenger, RCS, etc.). La comunicación en cada una de estas integraciones está protegida por los mecanismos de seguridad que ofrezca cada canal, principalmente basados en TLS 1.2 (HTTPS, SMTPS, VPN).

3.           Generación y envío de PIN #

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

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″
}

4.           Validación de PIN #

Este API es utilizado para consultar la validación de un PIN. Recibe como parámetros el otpId usado al momento de la generación y el PIN que se desea consultar

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/validateOtp

Ejemplo de la petición

• Content-Type: application/json
• JSON petición:

{

“otpId”: “string”,

“pin”: “string”

}