Detalle de la API

Para poder utilizar esta API se debe realizar una llamada con un método GET conformándose por:

• Endpoint: 

https://cont.certisend.com/web/container/api/v1/certisend/codetrack/getinfo

Parámetros de entrada:

• token-susc: Token obtenido al momento de la suscripción a nivel empresa.
• token-api: Token obtenido al momento de la suscripción a nivel API.
• code: Código único obtenido desde las API's "SMS Code Gold" y/o "ERN Complete Code Gold" al realizar un envío exitoso.
• pin: Código OTP generado en las API's "SMS Code Gold" y/o "ERN Complete Code Gold". 
• id_internal: Parámetro opcional en donde se puede enviar un id interno para su identificación por parte del cliente.

La llamada quedaría de la siguiente manera:

Ambiente homologación: https://cont1-desa1.certisend.com/web/container/api/v1/certisend/codetrack/getinfo?token-susc=TOKENSUSC&token-api=TOKENAPI&code=543fc578e8070f4322b789b71b514321&pin=647321&internalid=12

Ambiente productivo: https://cont.certisend.com/web/container/api/v1/certisend/codetrack/getinfo?token-susc=TOKENSUSC&token-api=TOKENAPI&code=543fc578e8070f4322b789b71b514321&pin=647321&internalid=12

Una vez realizada la llamada van a recibir los siguientes parámetros:

• state: Tendrá diferentes valores dependiendo lo sucedido con la comunicación, donde se destacan:
       - 0: Parámetro de entrada faltante o erroneo.
       - 1: Validación de código exitosa.
       - 2: Pin ingresado Inválido.
       - 3: Si se envía solo el código, se obtendrá la información correspondiente al registro insertado en la tabla.
              Si se envía el código mas el PIN y fue seteado un tiempo de expiración, se puede saber si el código se encuentra vencido.
       - 4: Indica si un PIN fue validado con anterioridad.
• desc: Descripción del estado numérico obtenido.
• code: Código único obtenido desde las API's "SMS Code Gold" y/o "ERN Complete Code Gold" al realizar un envío exitoso.
• sent: Fecha de envío del PIN.
• validated: Fecha en la que fue validado el PIN (la fecha solo aparecerá si el PIN fue validado).
• expiration_time: Fecha de expiración del PIN (la fecha solo aparecerá si fue seteada la fecha de expiración del PIN).
• id_internal: ID interno ingresado por el cliente.

Respuestas de Ejemplo:

Negativas:

Respuesta code Error:

{"state": 0,"desc": "Invalid code","code": "f3e6487cde6b2c554ce7b58db6f7b92","sent": "","validated": "","expiration_time": "","id_internal": "15"}

Respuesta Validación Pin Fallida:

{"state": 2,"desc": "Invalid pin","code": "f3e6487cde6b2c554ce7b58db6f7b920","sent": "2021-06-16 13:10:24","validated": "","expiration_time": "","id_internal": "15"}

Respuesta Fecha de Vencimiento pasada:

{"state": 3,"desc": "Expired validation time","code": "74b7d423d0ce1a0cf541e8842be7c3ea","sent": "2021-06-16 13:10:24","validated": "","expiration_time": "2021-06-16 13:40:24","id_internal": "15"}

Positivas:

Respuesta Validación Pin OK:

{"state": 1,"desc": "The validation was succesfull","code": "f3e6487cde6b2c554ce7b58db6f7b920","sent": "2021-08-24 14:24:49","validated": "2021-08-24 14:29:09","expiration_time": "2021-08-24 16:29:09","id_internal": "15"}

Respuesta sin Parámetro "pin" de Entrada, con el Parámetro "code" OK:

{"state": 3,"desc": "Valid code","code": "f3e6487cde6b2c554ce7b58db6f7b920","sent": "2021-08-24 14:24:49","validated": "2021-08-24 14:29:09","expiration_time": "2021-08-24 16:29:09","id_internal": "15"}

Respuesta de Pin Validado con Anterioridad:

{"state": 4,"desc": "the pin code was previously validated.","code": "f3e6487cde6b2c554ce7b58db6f7b920","sent": "2021-08-24 14:24:49","validated": "2021-08-24 14:29:09","expiration_time": "2021-08-24 16:29:09","id_internal": "15"}

Se encuentra a disposición para consultar la documentación técnica, revisar los parámetros de entrada/salida y evaluar las respuestas de la api accediendo a nuestro API-Doc. Así mismo si se registra gratuitamente en nuestro sistema, puede acceder a generar sus Token de Prueba e ingresar a nuestro portal API-Test

Definición Técnica de la API: