Documentacion OTP

1. APIs

En el modulo de API nos dirigimos a "OTP" (pruebas o producción).

2. Metodo Authenticate

En el metodo Authenticate dando click al boton "Try it" visualizaremos el cuerpo de la request donde digitaremos las credenciales. Activando el boton "Send" tendremos como respuesta un token que sera guardado en el cache de la pagina

3. Metodo Validate

Por ultimo nos dirigimos al metodo validate y dando click al boton "Try it" digitaremos en el cuerpo de la request el documento a consultar, finalizando con el boton "Send" para enviar la petición

4. Video Consumo

Introduccion

Para la integración de nuestros clientes con el servicio de OTP, contamos con una API que permite generar códigos de seguridad, esta tecnología facilita la integración rápida y transparente con el fin de potencializar el negocio de nuestros clientes y asociados. A continuación, se detalla paso a paso cómo comunicarse con nuestro servicio.

1. Generación Codigo OTP

Esta basado en llamados HTTP POST hechos por el cliente una URL.


1.1 URL Petición

https://reconoserpruebas.olimpiait.com:6341/ApiOtp/ConsultaGeneracionOTP

1.2 Parametros de Petición

Parámetro Descripción
Código aplicación Es el código GUID asignado al cliente para el consumo del servicio
Usuario Es el usuario asignado al cliente para el consumo del servicio
Contraseña Es la contraseña asignado al cliente para el consumo del servicio
Celular Número de celular de la persona a la que se le enviará un SMS con el OTP generado (el mensaje no se enviará si la aplicación no tiene la opción configurada)
Correo Correo electrónico de la persona a la que se le enviará un mensaje de correo con el OTP generado

1.3 Ejemplo de Petición

 {

"CodigoAplicacion":"13AB692F-C871-4750-B646-2082D407BAB2",

"Usuario": "user",

"Contrasena":"contrasena",

"Celular":"313000000",

"Correo":"user@test.test"

}

1.4 Ejemplo Respuesta

 {

"CodigoAplicacion":"0",

"DescripcionRespuesta": "user",

"IdConsulta":"171748",

"Identificador":"da158cce-0241-4ac0-99e4-7cef10c2584b"

"TextoOTP":""

}

1.5 Descripción Respuesta

Campo Descripción
CodigoRespuesta Código de la respuesta del servicio web, puede ser 0, 1 o 2 *0: si el método se ejecutó exitosamente *1: si hay campos que requieren validación *2: si hubo un error en la ejecución
DescripciónRespuesta 0:"OK" 1:"VALIDAR" 2:"ERROR"
IdConsulta Identificador de la consulta generada al invocar el servicio
Identificador GUID asignado al OTP generado
TextoOTP Texto del OTP generado de acuerdo a los parámetros establecidos para la aplicación

1.6 Codigos de Error

Codigo Descripción Mensaje al Usuario
0 consulta realizada con éxito OK
1 Error de validación GUID Aplicación vacío
1 Error de validación Credenciales no válidas para la aplicación solicitada o usuario inactivo
1 Error de validación Número de celular no válido
  • 2.2 Parámetros Petición
  • 2.3 Ejemplo Petición
  • 2.4 Ejemplo Respuesta
  • 2.5 Descripción Respuesta

    • 2 Validación de Código OTP

    Esta basado en llamados HTTP POST hechos por el cliente una URL.


    2.1 URL Petición

    https://reconoserpruebas.olimpiait.com:6341/ApiOtp/ConsultaValidacionOTP

    2.2 Parametro de Petición

    Código Descripción
    Código aplicación Es el código GUID asignado la cliente para el consumo del servicio
    Usuario Es el usuario asignado al cliente para el consumo del servicio
    Contrasena Es la contraseña asignado al cliente para el consumo del servicio
    Identificador GUID asignado al OTP devuelto en la generación del OTP que se desea validar
    TextoOTP Texto del código OTP a validar

    2.3 Ejemplo de Petición

     {

    "CodigoAplicacion":"13AB692F-C871-4750-B646-2082D407BAB2",

    "Usuario": "user",

    "Contrasena":"contrasena",

    "Identificador":"fhfhds",

    "TextoOTP":"1234"

    }

    2.4 Ejemplo de Respuesta

     {

    "CodigoRespuesta":"0",

    "DescripcionRespuesta": "1",

    "EsValidoOTP":"false",

    "IdConsulta":"171751",

    }

    2.5 Descripción Respuesta

    Campo Descripción
    CodigoRespuesta Código de la respuesta del servicio web, puede ser 0, 1 o 2. 0: si el método se ejecutó exitosamente 1: si hay campos que ***requieren validación 2: si hubo un error en la ejecución
    DescripcionRespuesta 0:"OK, 1:"VALIDAR", 2:"ERROR"
    EsValidoOTP Identificador de la consulta generada al invocar el servicio
    IdConsulta Identificador de la consulta generada al invocar el servicio

    2.6 Codigo Error

    Código Descripción Mensaje al Usuario
    0 Consulta realizada con éxito OK
    1 Error de validación GUID de Aplicación vacío
    1 Error de validación Credenciales no válidas para la aplicación solicitada o usuario Inactivo
    1 Error de validación GUID de Identificador vacío