Manual de Integración Validador Email

Manual de Integración Validador Email mail (MAN-PP-03-05) #

 

Contenido #

  1. Control de cambios………………………………………………………….. 2
  2. Validaciones del servicio……………………………………………………. 3
  3. Servicio Web de Validación………………………………………………… 4

Objetivo………………………………………………………………………. 4

Servicio web…………………………………………………………………. 4

Request………………………………………………………………………. 5

Response…………………………………………………………………….. 5

  1. Módulo Java Script………………………………………………………… 6

Qué incluir……………………………………………………………………. 6

Cómo utilizar…………………………………………………………………. 6

 

1.            Control de Cambios #

 

 

VersiónFechaDescripción de la ModificaciónResponsable (s)
103/12/2018Creación del manual de integración para el validador de E-mailVíctor Duarte Daniel Gómez
228/10/2019Generación de un nuevo

status

Luis Eduardo Rodríguez

 

2.            Validaciones del servicio #

El servicio expuesto de validación se compone de una serie de verificaciones sobre cada uno de los correos electrónicos consultados:

  • Se verifica la sintaxis del correo electrónico la cual debe coincidir con la estructura: nombre@dominio.xx
  • Se verifica en los DNS mundiales la existencia del
  • Se realiza la consulta de si el dominio permite la entrega de correos electrónicos (dominio SMTP).
  • Se consulta si en el dominio consultado existe el nombre de del correo electrónico.
  • Las consultas de dominios y nombres son almacenadas en una base de datos que almacena el estado de la validación de forma temporal para hacer más eficiente y rápido el Este almacenamiento es en promedio 3 a 6 meses.

Debido a que la consulta de dominios y nombres en el dominio, debe recorrer DNS en toda la red mundial de internet, la consulta tiene un tiempo promedio de 2 minutos por cada correo validado.

El servicio expuesto se diseñó para la validación de correos 1 a 1, en caso de requerir validar bases con gran cantidad de correos electrónicos, se recomienda el uso de nuestra herramienta Web de validación.

 

3.            Servicio Web de Validación #

 

Objetivo

 

Este Servicio Web (WS) permitirá que el cliente valide correos electrónicos. Se realizan validaciones de Sintaxis, Dominio, y correo dentro del dominio.

 

Servicio web

 

La dirección del WS a utilizar es:

 

 

DescripciónInicia la transacción
 

 

Entradas

APIKEY (String): Proporcionada por ALDEAMO al cliente que contrate el servicio.

EMAIL (String): Dirección de correo electrónico que desea validar.

 

 

 

 

 

 

Salidas

RESPONSE (String Json): Respuesta enviada por Aldeamo:

 

{“status”:1,”reason”:”Request Received”,”data”:{“isValid”:true,”isSafe”:false}}

 

STATUS:

 

-1: Success / Request Received

-1: Unauthorized / Authentication Error

-5: Error / Transaction Error

 

isValid:

 

true: Correo Electrónico valido

false: Correo Electrónico invalid

 

isSafe:

 

true: Correo electrónico seguro.

False: Correo electrónico inseguro.

Tabla 1. Parameters HTTP GET Validator email

 

3.1. Ejemplo de Uso #

Request

 

 

Response

 

 

{

“status”:1,

“reason”:”Request Received”,

“data”

“isValid”:true,

“isSafe”:false

}

}

 

www.aldeamo.com

 

4.             Módulo Java Script #

 

A continuación, modulo Java Script que se debe incluir en el formulario HTML del cliente en caso de necesitar esté tipo de integración (aldeamo_module.js).

var aldeamo_module = (function($){ return{

validEmail : function(email){

 

$.get(“http://validator.aldeamo.com/emailvalidator/single?apikey=[APIKEY]&destination= “+email,function(response) {

if(response.status != 1){

return -1;

 

 

 

});

}

}

}

return response.data.isValid;

 

})(jQuery);

 

 

¿Qué incluir?

 

 

<script src=”https://code.jquery.com/jquery-3.3.1.min.js”></script>

<script src=”assets/js/aldeamo_module.js”></script>

 

 

¿Cómo utilizar?

 

 

<input type=”text” class=”form-control” id=”email” name=”email” autofocus=”true” onblur=”aldeamo_module.validEmail(this.value);”/>

Powered by BetterDocs

Leave A Comment

Este sitio usa Akismet para reducir el spam. Aprende cómo se procesan los datos de tus comentarios.