Contenido
Lista de campañas
Servicio: /api/v1/mailout/(Ident Formulario) Resultado: JSON
Este API despliega la lista de campañas activas relacionados con un formulario específico. Es decir las campañas de la ruta Tareas -> Contactos -> Campañas:
Parámetros
link
Boolean. Definido como true, retorna los enlaces a datos relacionados.
Correos en campaña
Servicio: /api/v1/mailout/(id mailout)/emails Resultado: JSON
Este API despliega la lista de correos de la campaña asociada (id mailout). Este id se obtiene del API anterior.
Resultados de la campaña
Servicio: /api/v1/mailout/(id mailout)/emails/totals Resultado: JSON
Este API retorna las estadísticas o resultados de una campaña específica (id mailout). Este id se obtiene del API de campañas.
Los datos corresponden al resumen que se visualiza en la descripción de la Campaña.
Crear/Editar una campaña
Servicio: /api/v1/mailout/ Método: POST
Este API permite crear o editar una campaña para lo cual debe agregar un JSON con los mismos parámetros que retorna la LISTA DE CAMPAÑAS. El archivo de carga es enviado codificado como x-www-form-urlencoded y con key = mailout
mailout = {
"survey_ident": s790_17874,
"name": "Prueba Campaña",
"subject": "Asunto de Correo",
"content": "Hola ${name},\n\Favor diligenciar en este enlace"
}
Ejemplo en POSTMAN
El resultado es:
Cuando se requiere editar una campaña se incluye el id de la campaña en el JSON como “id”:nnn,
Crear/Editar un correo para una campaña
Servicio: /api/v1/mailout/(id de campana/email Método: POST
Este API permite crear o editar un correo para una campaña para lo cual debe agregar un JSON con los mismos parámetros que retorna la CORREOS EN CAMPAÑAS.
El archivo de carga es enviado codificado como x-www-form-urlencoded y con key = email
Hay un segundo parámetro opcional con key action y valores “email”, “manual” o “none”. Si la acción es email, entonces se envía un correo electrónico inmediatamente. Alternativamente, si la acción es manual, retorna la URL para completar el formulario. Si la acción no se incluye o es establecida como none, el correo es colocado en cola en la campaña y deberá ser enviado por el usuario desde la interface de Campañas
email = {
"email": "[email protected]",
"name": "Contacto KONTROLID",
"initialData": {
"values": {
"q1": "Hola Mundo"
}
}
}
action=manual
Ejemplo 1 en POSTMAN :
Campaña con correo
Ejemplo 2 en POSTMAN:
Campaña sin correo
Con este ejemplo se muestra cómo se crea un formulario web anónimo desde una campaña y dado que el resultado es una URL permite precargar datos desde un formulario externo.
https://kid.ibasoft.com.co/helppeople
Los datos que se piden inicialmente de OT y usuario se hacen externos a Kontrolid y después de hacer clic en el botón TRAER FORMULARIO se ejecuta el API referido.
