Email API — Validar una dirección de correo electrónico (REST)

Support DQE
Support DQE
  • Actualización

Utilice este endpoint RESTful para validar una dirección de correo electrónico y obtener información sobre su sintaxis, dominio, capacidad de entrega y estado de actividad.

Ver también: Documentación Swagger de Email RESTful

Solicitud GET

Endpoint

GET https://{SERVER_ADDRESS}/{VERSION}/email/lookup?email={EMAIL}&rectify={RECTIFY}&extendedSyntax={EXTENDED_SYNTAX}&checkUser={CHECK_USER}&timeout={TIMEOUT}

Reemplace los valores entre llaves con su propia información.

Parámetro Descripción Obligatorio/Opcional
email Dirección de correo electrónico a validar. Obligatorio
rectify true para proponer una corrección de dominio cuando el dominio introducido es desconocido; false en caso contrario. Opcional
extendedSyntax true para aceptar direcciones de correo electrónico con sintaxis extendida; false para limitar las comprobaciones a direcciones de correo electrónico estándar. Opcional
checkUser true para comprobar la parte anterior al símbolo @; false para comprobar únicamente el dominio. Opcional
timeout Tiempo máximo de consulta para la verificación, en segundos. Opcional

Solicitud POST

Endpoint

POST https://{SERVER_ADDRESS}/{VERSION}/email/lookup

Envíe los siguientes parámetros en el cuerpo de la solicitud usando JSON.

Parámetro Descripción Obligatorio/Opcional
email Dirección de correo electrónico a validar. Obligatorio
rectify true para proponer una corrección de dominio cuando el dominio introducido es desconocido; false en caso contrario. Opcional
extendedSyntax true para aceptar direcciones de correo electrónico con sintaxis extendida; false para limitar las comprobaciones a direcciones de correo electrónico estándar. Opcional
checkUser true para comprobar la parte anterior al símbolo @; false para comprobar únicamente el dominio. Opcional
timeout Tiempo máximo de consulta para la verificación, en segundos. Opcional

Ejemplo:

{
  "email": "test@example.com",
  "rectify": true,
  "extendedSyntax": false,
  "checkUser": true,
  "timeout": 0.5
}

Respuesta

Respuesta correcta

La respuesta JSON contiene los detalles de validación de la dirección de correo electrónico proporcionada.

Clave Descripción Tipo
IdError Código de error devuelto por la API. INTEGER
Error Mensaje de error asociado al resultado de la validación. STRING
Formatted Dirección de correo electrónico normalizada y formateada. STRING
LocalPart Parte anterior al símbolo @. STRING
Domain Nombre de dominio del correo electrónico. STRING
Tld Dominio de nivel superior. STRING
IsValid Indica si la sintaxis del correo electrónico es válida. BOOLEAN
IsDisposable Indica si el correo electrónico pertenece a un proveedor desechable. BOOLEAN
IsCatchAll Indica si el dominio acepta todos los correos electrónicos. BOOLEAN
IsFree Indica si el proveedor es gratuito. BOOLEAN
IsRole Indica si la dirección corresponde a un rol (no a una persona). BOOLEAN
IsDeliverable Indica si la dirección de correo electrónico es entregable. BOOLEAN
HasSuggestedCorrection Indica si hay disponible una sugerencia de corrección. BOOLEAN
SuggestedCorrection Dirección de correo electrónico corregida sugerida. STRING
DomainExists Indica si el dominio existe. BOOLEAN
HasMxRecords Indica si hay registros MX disponibles. BOOLEAN

Ejemplo:

{
  "IdError": 0,
  "Error": "",
  "Formatted": "test@gmail.com",
  "LocalPart": "test",
  "Domain": "gmail.com",
  "Tld": "com",
  "IsValid": true,
  "IsDisposable": false,
  "IsCatchAll": false,
  "IsFree": true,
  "IsRole": false,
  "IsDeliverable": true,
  "HasSuggestedCorrection": false,
  "SuggestedCorrection": "",
  "DomainExists": true,
  "HasMxRecords": true
}

Respuesta de error

Tipo de error Tipo de respuesta
Autenticación faltante o no válida 401 Unauthorized
Falta el parámetro email 400 Bad Request
Sintaxis de correo electrónico no válida Respuesta de error de validación

Ver también

Relacionada con

¿Fue útil este artículo?

Usuarios a los que les pareció útil: 0 de 0