Documentos de Académico
Documentos de Profesional
Documentos de Cultura
Fecha: 28/04/2020
CONTROL DE VERSIÓN
Identificador CC-GD001
Tabla de Contenido
Objetivo 6
Definiciones 6
Operaciones del servicio 6
Autenticación 7
3.1.1 Parámetros 7
3.1.2 Ejemplo JSON de entrada 7
3.1.3 Respuesta 7
3.1.4 Ejemplo JSON de salida 9
3.1.5 Valores para el atributo de statusCode 9
3.1.6 Uso del token 9
Cargue de Templates 10
3.2.1 Parámetros de entrada 10
3.2.2 Ejemplo 10
3.2.3 Respuesta 10
3.2.4 Ejemplo JSON de respuesta 11
3.2.5 Valores para el atributo de statusCode 11
Envío de correo certificado 11
3.3.1 Parámetros de entrada 11
3.3.2 Ejemplo 12
3.3.3 Respuesta 12
3.3.4 Ejemplo JSON de respuesta 13
3.3.5 Valores para el atributo de statusCode 13
Envío de correo certificado con template 14
3.4.1 Parámetros de entrada 14
3.4.2 Ejemplo: 15
3.4.3 Respuesta 15
3.4.4 Ejemplo JSON de respuesta 16
3.4.5 Valores para el atributo de statusCode 16
Envío masivo de correo certificado 17
3.5.1 Parámetros de entrada 17
Acuerdo de interfaz
Fecha: 28/04/2020
3.5.2 Ejemplo 18
3.5.3 Respuesta 18
3.5.4 Ejemplo JSON de respuesta 19
3.5.5 Valores para el atributo de statusCode 19
Envío de correo certificado masivo con template 20
3.6.1 Parámetros de entrada 20
3.6.2 Ejemplo: 21
3.6.3 Respuesta 21
3.6.4 Ejemplo JSON de respuesta: 22
3.6.5 Valores para el atributo de statusCode 22
Obtención del acta de un correo enviado 23
3.7.1 Parámetros de entrada 23
3.7.2 Ejemplo 23
3.7.3 Respuesta 23
3.7.4 Ejemplo JSON de respuesta 24
3.7.5 Valores para el atributo de statusCode 24
Obtener los identificadores de todos los correos enviados 25
3.8.1 Parámetros de entrada 25
3.8.2 Ejemplo 25
3.8.3 Respuesta 26
3.8.4 Ejemplo JSON de respuesta 27
3.8.5 Valores para el atributo de statusCode 27
Obtener los eventos con el id email 27
3.9.1 Parámetros de entrada 28
3.9.2 Ejemplo 28
3.9.3 Respuesta 28
3.9.4 Ejemplo JSON de respuesta 29
3.9.5 Valores para el atributo de statusCode 30
3.9.6 Eventos de correo 30
Acuerdo de interfaz
Fecha: 28/04/2020
Acuerdo de interfaz
Fecha: 28/04/2020
Objetivo
Este documento pretende describir de manera técnica y detallada el consumo del servicio
web de correo certificado.
Definiciones
WS: Web Service o Servicio orientado a la Red, cuenta con la integración de aplicativos
Web mediante el uso de JSON, REST que permite intercambiar información (lógica de
negocio, datos y/o procesos) entre organizaciones sin una interfaz gráfica.
Las URL de acceso para cada uno de los ambientes serán las siguientes:
Autenticación
URL: {{url-ambiente}}/v1/auth/login
3.1.1 Parámetros
3.1.3 Respuesta
petición.
Descripción del
statusDescription Cadena max Si código de la
transacción.
Resultado de la
result Objeto Si
consulta.
Identificador del
result._id Cadena max Si
usuario.
Correo electrónico
result.email Cadena max Si
del usuario.
Nombres del
result.firstName Cadena max Si
usuario.
Apellidos del
result.lastName Cadena max Si
usuario.
Estado de cambio de
result.changePassw
Booleano Si contraseña del
ord
usuario.
Compañía del
result.companyID Objeto Si
usuario.
Tipo de envío de
result.attachment Cadena 3 Si
adjuntos.
Token para
result.token Cadena max Si
autenticación.
Acuerdo de interfaz
Fecha: 28/04/2020
Código Descripción
200 Transacción exitosa, usuario
autenticado.
422 No se encontró el usuario.
422 Contraseña incorrecta.
422 "password": "Este campo es
obligatorio"
503 Lo sentimos, ha ocurrido un error
interno y no pudimos completar tu
solicitud.
Se usa el token en la cabecera Authorization con el token acompañado del texto “Token”.
Ejemplo:
Acuerdo de interfaz
Fecha: 28/04/2020
Cargue de Templates
Operación POST que permite el cargue de plantillas de correo para su posterior uso en
envío de correos certificados con template y correos masivos con template.
Se envía en el body el objeto JSON que debe cumplir con los siguientes atributos:
Tamaño
Nombre Tipo Descripción
Obligatorio
filename Cadena Si Nombre de la plantilla.
template Cadena Si Cadena del html en base64.
3.2.2 Ejemplo
3.2.3 Respuesta
Código Descripción
200 Transacción exitosa.
401 Token vencido o incorrecto.
403 Usuario sin permisos.
"x campo": "Este campo es
422
obligatorio"
Lo sentimos, ha ocurrido un error.
503 interno y no pudimos completar tu
solicitud.
Se envía en el body el objeto JSON que debe cumplir con los siguientes atributos
Acuerdo de interfaz
Fecha: 28/04/2020
Tamaño
Nombre Tipo Descripción
Obligatorio
to Vector Si Correo de destino.
subject Cadena Si Asunto del correo.
description Cadena Si Mensaje del correo.
attachments Vector No Adjuntos en base64.
Tipo de documento y cadena en
attachments.content Cadena No
base64.
attachments.filename Cadena No Nombre del documento.
Tipo de extensión del archivo
según las extensiones
Attachments.mimetype Cadena No
multipropósito de correo de
internet.
Attachments.size Número No Tamaño del archivo en bytes.
3.3.2 Ejemplo
3.3.3 Respuesta
Código Descripción
200 Consulta exitosa.
400 No tienes saldo disponible.
El correo de este usuario no se ha
400
verificado.
401 Token vencido o incorrecto.
403 Usuario sin permisos.
404 No encontrado.
"x campo": "Este campo es
422
obligatorio"
Lo sentimos, ha ocurrido un error.
503 interno y no pudimos completar tu
solicitud.
Operación POST que permite el envío de un correo certificado con template. Como
resultado se obtiene el id del mensaje.
Se envía en el body el objeto JSON que debe cumplir con los siguientes atributos
3.4.2 Ejemplo:
3.4.3 Respuesta
Operación POST que permite el envío de un correo certificado de forma masiva. Como
resultado se obtiene el id del mensaje.
Se envía en el body el objeto JSON que debe cumplir con los siguientes atributos
3.5.2 Ejemplo
3.5.3 Respuesta
Dirección de correo
invalidEmails.email Cadena No
invalida.
Razón por la cual el
correo es invalido. Ver
documento: “Anexo
invalidEmails.reason Cadena No técnico API Correo –
Callback Validación de
estados para envío
correo”.
Código Descripción
200 Consulta exitosa.
400 No tienes saldo disponible.
400 El correo de este usuario no se ha
verificado.
401 Token vencido o incorrecto.
403 Usuario sin permisos.
404 No encontrado.
"x campo": "Este campo es
422
obligatorio"
503 Lo sentimos, ha ocurrido un error.
interno y no pudimos completar tu
solicitud.
Acuerdo de interfaz
Fecha: 28/04/2020
Operación POST que permite el envío de un correo certificado masivo. Como resultado
se obtiene el id del mensaje.
Se envía en el body el objeto JSON que debe cumplir con los siguientes atributos
3.6.2 Ejemplo:
3.6.3 Respuesta
Código Descripción
200 Consulta exitosa.
400 No tienes saldo disponible.
El correo de este usuario no se ha
400
verificado.
401 Token vencido o incorrecto.
403 Usuario sin permisos.
404 No encontrado.
"x campo": "Este campo es
422
obligatorio"
Lo sentimos, ha ocurrido un error.
503 interno y no pudimos completar tu
solicitud.
Acuerdo de interfaz
Fecha: 28/04/2020
Operación GET que permite la obtención del acta de un correo especificado. Como
resultado se obtiene un documento codificado en base64 y su nombre.
URL: {{url-ambiente}}/v1/emailAPI/:emailID/record/
Se envía una URL que debe cumplir con los siguientes atributos
3.7.2 Ejemplo
URL: {{url-ambiente}}/v1/emailAPI/010001742ccfb009-e6051356-6e69-4d07-b88d-
dc78fe3e3f04-000000/record/
3.7.3 Respuesta
Acuerdo de interfaz
Fecha: 28/04/2020
Código Descripción
200 Solicitud exitosa.
401 Token vencido o incorrecto.
403 Usuario sin permisos.
404 No encontrado.
Lo sentimos, ha ocurrido un error.
503 interno y no pudimos completar tu
solicitud.
Acuerdo de interfaz
Fecha: 28/04/2020
Operación GET que permite obtener los identificadores de todos los correos enviados.
Como resultado se obtiene el id, id del mensaje, para, asunto, el tipo y la fecha de
creación.
URL: {{url-ambiente}}/v1/emailAPI
Las fechas se deben enviar en los params de la petición teniendo en cuenta que para un
día especifico se debe enviar el parámetro “date” y para un periodo de fechas se deben
enviar los parámetros “startDate” y “endDate”:
3.8.2 Ejemplo
Acuerdo de interfaz
Fecha: 28/04/2020
3.8.3 Respuesta
Descripción de la
statusDescription Cadena Si
respuesta,
Resultado de la
result Vector Si
operación
Datos de la compañía
desde la que fue
result.companyID Objeto Si
enviado el correo
electrónico
ID único,
correspondiente a un
result.emailID Cadena Si correo electrónico
enviado desde la
plataforma.
Fecha y hora de
result.createdAt Fecha Si creación de la
notificación
Acuerdo de interfaz
Fecha: 28/04/2020
Responde con los datos del correo o correos enviados en la fecha indicada.
Código Descripción
200 Consulta exitosa.
401 Token vencido o incorrecto.
403 Usuario sin permisos.
503 Servicio no disponible.
Operación GET que permite obtener los eventos de un correo enviado usando el id del
email. Como resultado se obtiene el evento, la fecha del evento y el resultado del evento.
URL: {{url-ambiente}}/v1/emailAPI/:emailID
3.9.2 Ejemplo
URL: {{url-ambiente}}/v1/emailAPI/0100017444cf4e3d-7ef6ffe1-eee4-45b1-bce6-
477b98763d42-000000
3.9.3 Respuesta
Descripción de la
statusDescription Cadena Si
respuesta,
Retorna un tipo de
evento del correo.
Código Descripción
200 Consulta exitosa.
401 Token vencido o incorrecto.
403 Usuario sin permisos.
503 Servicio no disponible.