PUBLICAR en el punto final de verificación
Enviar la solicitud a https://api.listcleaner.net/verify_email. Utilice HTTPS y un cuerpo de solicitud JSON.
Ruby guía API
Verificar direcciones de correo electrónico con Ruby.
Envíe una solicitud JSON segura con Net::HTTP, autentíquese con el correo electrónico de su cuenta y la clave API, y use el estado devuelto directamente en su aplicación.
Antes de comenzar
Una solicitud Ruby completa tiene cuatro partes.
El ejemplo utiliza Ruby with its standard HTTP and JSON libraries. Almacene las credenciales en variables de entorno del lado del servidor y sustituya la dirección que necesita verificar.
Enviar ambos encabezados de credenciales
Añadir X-User-Email y X-Api-Key en el servidor. Nunca exponga una clave API privada en el navegador público JavaScript.
Proporcionar una dirección de correo electrónico
Codifique la dirección como JSON usando el email propiedad. Deje que la biblioteca JSON del idioma escape el valor correctamente.
Leer el código HTTP y el estado JSON
Una respuesta exitosa incluye success, request_id, email y status. Maneje los errores antes de confiar en esos campos.
Solicitud completa
Copie el ejemplo de Ruby.
La solicitud copiada incluye el nombre de usuario y los encabezados de la clave API. Reemplace los valores de ejemplo con la configuración del lado del servidor en producción.
Usa la respuesta
Trate los resultados de transporte, API y verificación por separado.
Un éxito HTTP significa que la API procesó la solicitud. el status describe el resultado de la dirección. Las fallas de red, los tiempos de espera, los errores de autenticación y los créditos insuficientes necesitan un manejo diferente al de una dirección que no se puede entregar.
- Verifique el estado de HTTP. Analice JSON solo cuando haya un cuerpo de respuesta disponible.
- comprobar
success. En caso de error de API, registre el ID de la solicitud y utilice el comportamiento de error documentado. - Utilice el estado de verificación. Asigne estados ListCleaner a una política de producto explícita en lugar de asumir que todos los resultados no correctos son idénticos.
- Conserve el ID de la solicitud. Proporciona una referencia segura para registros y soporte sin exponer credenciales.
Ejemplo de respuesta exitosa
{
"success": true,
"request_id": "7ad81f...",
"email": "customer@example.com",
"status": "OK"
}La respuesta del público sigue siendo concisa. Su solicitud decide si un estado particular debe aceptarse, revisarse o rechazarse.
Lista de verificación de producción
Haga que la integración sea segura y predecible.
Proteger credenciales
Cargue el correo electrónico del usuario y la clave API desde el entorno o la configuración secreta. No los envíe al control de código fuente, no los registre ni los devuelva a un navegador.
Establecer tiempos de espera razonables
Utilice tiempos de espera de conexión y de solicitud total. Trate un tiempo de espera de transporte como un resultado no disponible, no como una prueba de que la dirección enviada no es válida.
Iniciar sesión de forma segura
Registre el ID de la solicitud, el código HTTP, la duración y el estado final. Evite el almacenamiento innecesario de credenciales sin procesar o conjuntos de datos personales completos.
Preguntas frecuentes sobre Ruby
Preguntas comunes sobre integración.
Utilice la documentación interactiva para los campos de solicitud autorizados y la consola de pruebas en vivo.
¿Dónde debo almacenar la clave API ListCleaner?
Guárdelo en un entorno del lado del servidor o en una configuración secreta. Nunca lo incrustes en un JavaScript público, un paquete de aplicaciones móviles o un archivo fuente confirmado.
¿La verificación única envía un correo electrónico a la dirección?
No. El endpoint devuelve su estado técnico sin enviar un mensaje de verificación al destinatario.
¿Debo bloquear todos los resultados que no estén bien?
No. Los resultados generales, temporales e inciertos necesitan una política documentada. Reserve el rechazo total para estados que proporcionen pruebas suficientemente sólidas para su caso de uso.
¿Puedo limpiar archivos completos de Ruby?
Sí. La API también admite flujos de trabajo de listas asincrónicas: cargue un archivo compatible, conserve el identificador del trabajo, sondee su estado y descargue el resultado final.
Otros idiomas