Módulo administratoremail

Este modulo agrupa servicios de administración de listas de direcciones de correo electrónico utilizados como remitente de las campañas y formularios de suscripción.

1.Seguimiento en tiempo real

Servicio:

/administratoremail/list

Listar direcciones de correo electrónico

Parámetros:

Parámetrocount
RequeridoNO
TipoNúmero Entero
ExplicaciónNúmero de registros como máximo por página
Ejemplocount=10
Parámetroabsolutepage
RequeridoNO
TipoNúmero Entero
ExplicaciónPágina de "count" registros a la que se quiere ir. Si count vale 10 y absolutepage vale 3, entonces empezaremos a ver desde el registro 31
Ejemploabsolutepage=3

Errores:

errorMsg_formValidations
Uno o varios de los parámetros de entrada son incorrecto, faltan o son requeridos

Estructura de Salida:

list.item.EmailID
ID del registro
list.item.EmailAddress
Dirección de correo electrónico
list.item.Name
Etiqueta o nombre asociado a la dirección de correo electrónico
list.item.DkimPubKey
Clave pública de la firma DKIM (solo si está configurada)
list.item.DkimPrivKey
Clave privada de la firma DKIM (solo si está configurada)

** Solo se documentan los campos mas relevantes.

2.Crear o Modificar la información de una dirección de correo electrónico

Servicio:

/administratoremail/edit

Recupera, crea o edita los atributos de una dirección de correo electrónico. Si el llamado al servicio es por GET, recupera la información del registro solicitado. Si es por POST Crea o actualiza (si se ingresa el parametro EmailID) los datos del registro

Parámetros:

ParámetroEmailID
RequeridoNO
TipoNúmero Entero
ExplicaciónID del Registro
EjemploEmailID=2
ParámetroName
RequeridoSi (Solo por POST)
TipoCadena de caracteres
ExplicaciónEtiqueta o nombre asociado a la dirección de correo electrónico
EjemploName=Mi nombre
ParámetroEmailAddress
RequeridoSi (Solo por POST)
TipoCadena de caracteres
ExplicaciónDirección de correo electrónico
EjemploEmailAddress=minombre@midominio.com
ParámetroDkimPubKey
RequeridoNO
TipoCadena de caracteres
ExplicaciónClave pública de la firma DKIM
EjemploDkimPubKey=BEGIN PUBLIC KEY ######### END PUBLIC KEY
ParámetroDkimPrivKey
RequeridoNO
TipoCadena de caracteres
ExplicaciónClave privada de la firma DKIM
EjemploDkimPrivKey=BEGIN RSA PRIVATE
KEY#######END RSA PRIVATE
KEY

Errores:

errorMsg_formValidations
Uno o varios de los parámetros de entrada son incorrectos, faltan o son requerido
errorMsg_administratorEmailNotFound
El registro solicitado no se encuentra

Estructura de salida:

email.EmailID
ID del registro
email.Name
Etiqueta o nombre asociado a la dirección de correo electrónico
email.EmailAddress
Dirección de correo electrónico
email.DkimPubKey
Clave pública de la firma DKIM
email.DkimPrivKey
Clave privada de la firma DKIM
email.DNSRecord.name
Nombre de host DNS (Utilizado para la configuración de DKIM)
email.DNSRecord.value
Valor del registro (Utilizado para la configuración de DKIM)
email.DNSRecord.type
Tipo de registro de la Zona DNS (Utilizado para la configuración de DKIM)
email.dkimIsValid
Indica si la configuración DKIM es válida

** Solo se documentan los campos mas relevantes.

3.Generación automática de Claves DKIM

Servicio:

/administratoremail/genKey

Genera automáticamete un par de claves para utilizar en la configuración DKIM

Parámetros:

Estructura de salida:

openssl.public
Clave pública de la firma DKIM
openssl.private
Clave privada de la firma DKIM

** Solo se documentan los campos mas relevantes.

4.Verificar configuración DKIM

Servicio:

/administratoremail/testdkim

Verifica si la configuración de la firma DKIM y la información de los registros DNS sean correctos y estén actualizados

Parámetros:

ParámetroEmailID
RequeridoNO
TipoNúmero Entero
ExplicaciónID del Registro
EjemploEmailID=2

Errores:

errorMsg_formValidations
Uno o varios de los parámetros de entrada son incorrecto, faltan o son requeridos
errorMsg_administratorEmailNotFound
El registro solicitado no se encuentra

Estructura de salida:

email.EmailID
ID del registro
email.DNSRecord.name
Nombre de host DNS (Utilizado para la configuración de DKIM)
email.DNSRecord.value
Valor del registro (Utilizado para la configuración de DKIM)
email.dkimIsValid
Indica si la configuración DKIM es válida

** Solo se documentan los campos mas relevantes.

5.Borrar una dirección de correo electrónico

Servicio:

/administratoremail/delete

Elimina lógicamente una dirección de correo electrónico, el registro no estará disponible para su visualización en los listados pero podrá seguir siendo utilizado por el sistema para asegurar el correcto funcionamiento de las campañas que lo utilicen

Parámetros:

ParámetroEmailIds
RequeridoSI
TipoArreglo de números enteros
ExplicaciónID de los registros que se desea eliminar
EjemploEmailIds[]=2&EmailIds[]=5

Errores:

errorMsg_formValidations
Uno o varios de los parámetros de entrada son incorrecto, faltan o son requeridos
errors.notDeleted
Arreglo de IDs de registro que no han podido ser eliminados

Estructura de salida:

countDeleted
Número de registros eliminados satisfactoriamente
countNotDeleted
Número de registros que no han podido ser eliminados