Detalle de la API

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

• Endpoint: https://cont1-virtual1.certisend.com/web/container/api/v1/certisend/email/ern/codetrack

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.
• idcompany: Es el valor correspondiente al sector de la empresa que enviará la comunicación, el cual será entregado por Sysworld una vez que sea dada de alta en Certisend.
• idcampaing: Corresponde al ID del template que se enviará en la comunicación, este valor será entregado por Sysworld una vez que el template sea dado de alta.
• email: Email de la persona a la cual se le quiere enviar la comunicación.
• attachedfiles: En este parámetro se debe colocar los códigos obtenidos con la API "Attach File" para que sean adjuntados en el correo. Este campo permite ingresar múltiples valores los que deberán ser separados por el símbolo ";".
• field1 a field 10: Representan campos dinámicos que permitirán realizar modificaciones dinámicas de los textos utilizados en el template.
  Ejemplo: Si el template debe contar con el nombre y apellido de un cliente en cada envío, se deberá enviar en el parámetro "field1" el dato de la persona, el cual será reemplazado de forma dinámica al momento del envío.
  El campo a ser reemplazado será indica por Sysworld una vez que finalice la creación del template.
• digits: Cantidad de dígitos númericos que va a tener el código que recibirá el cliente. La cantidad no puede ser menor a 4 dígitos.
• expiry_time: Tiempo expiración que tendrá el código generado. (minutos).
• mark: En el caso de necesitar enviar códigos OTP con el mismo valor tanto por email como por SMS, se debe completar este campo con una palabra o texto alfanumérico.
  Luego, para finalizar el emparejamiento del PIN, se debe enviar el mismo valor en el parámetro "mark" de la API "SMS_Code_Gold" lo que permitirá que el código PIN sea el mismo en ambos envíos.
• 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:

https://cont1-virtual1.certisend.com/web/container/api/v1/certisend/email/ern/codetrack?token-susc=TOKENSUSC&token-api=TOKENAPI&idcompany=1&idcampaing=1&email=sysworld@sysworld.com.ar&field1=Francisco&digits=4&mark=marcacliente1&internalid=12

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

• state: Tendrá el valor 0 para un parámetro faltante o email no enviado y un 1 en el caso de que el envío sea exitoso.
• desc: Descripción del parámetro "state" recibido.
• code: Muestra el código generado para dar seguimiento al envío.
• id_internal: ID interno ingresado por el cliente.

Respuestas de Ejemplo:

Negativa:

{"state": "0","desc": "minimum digits must be 4","id_internal": "10"}

Positiva:

{"state": "1","desc": "email sent","code": "3cdfbc5ecb0cb63d02df7e9e9c2effa0","id_internal": "10"}

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: