Amazon S3 API para operaciones masivas - documentación
Incluir archivos de Amazon S3 en una lista
Estos puntos de enlace brindan la capacidad de incluir en una lista, validar, calificar y exportar archivos directamente desde y hacia su cubo de Amazon S3.
En el caso de que necesite incluir en una lista todos los archivos de su cubo de Amazon S3 que puedan ser validados o calificados, puede utilizarse el siguiente punto de enlace:
GET /listS3files
API URL: https://bulkapi.zerobounce.net/listS3files
Parámetros de URL:
Parameter
Description
api_key
Su clave API, que se encuentra en su cuenta. (Requerida)
bucket
Su cubo de entrada; en el caso de que no se suministre aquí, usaremos el que haya suministrado en los ajustes de la IU. (Opcional)
search
Usado para filtrar el resultado por el nombre de los archivos. (Opcional)
Si desea llamar a la API desde su navegador para probarla, todo lo que tiene que hacer es reemplazar {your_api_key} con su clave de API:
La API /listS3files arroja la lista completa de archivos que pueden ser validados o calificados desde el cubo de Amazon S3 suministrado. Cada entrada contendrá: el nombre del archivo, su tamaño y la fecha en la que se modificó por última vez.
Respuesta de error
Validar archivo de Amazon S3
Para validar un archivo de Amazon S3, usted puede utilizar el siguiente punto de enlace:
POST /validateS3file
API URL: https://bulkapi.zerobounce.net/validateS3file
Parámetros del cuerpo:
Parameter
Description
api_key
Su clave API, que se encuentra en su cuenta. (Requerida)
file_name
La ruta completa del archivo desde su cubo de Amazon S3, según lo suministrado por /listS3files. (Requerido)
has_header_row
Verdadero si la primera fila del archivo enviado es una fila de encabezado; de lo contrario, falso. (Requerido)
remove_duplicates
Verdadero si desea que el sistema elimine los correos electrónicos duplicados; de lo contrario, falso (por defecto, verdadero). Tenga en cuenta que, si eliminamos más del 50% de las líneas debido a valores duplicados (parámetro verdadero), el sistema arrojará un error de solicitud incorrecta 400 como red de seguridad para informarle que se ha modificado más del 50% del archivo. (Opcional)
return_url
El URL se utilizará para callback cuando se haya completado la validación. (Opcional)
RESPUESTA DE PUNTO FINAL
Respuesta exitosa
Respuesta de error
Calificar archivo de Amazon S3
Para validar un archivo del cubo de Amazon S3, usted puede utilizar el siguiente punto de enlace:
POST /scoreS3file
API URL: https://bulkapi.zerobounce.net/scoreS3file
Parámetros del cuerpo:
Parameter
Description
api_key
Su clave API, que se encuentra en su cuenta. (Requerida)
file_name
La ruta completa del archivo desde su cubo de Amazon S3, según lo suministrado por /listS3files. (Requerido)
has_header_row
Verdadero si la primera fila del archivo enviado es una fila de encabezado; de lo contrario, falso. (Requerido)
remove_duplicates
Verdadero si desea que el sistema elimine los correos electrónicos duplicados; de lo contrario, falso (por defecto, verdadero). Tenga en cuenta que, si eliminamos más del 50% de las líneas debido a valores duplicados (parámetro verdadero), el sistema arrojará un error de solicitud incorrecta 400 como red de seguridad para informarle que se ha modificado más del 50% del archivo. (Opcional)
return_url
El URL se utilizará para callback cuando se haya completado la validación. (Opcional)
RESPUESTA DE PUNTO FINAL
Respuesta exitosa
Respuesta de error
Buscador de correo electrónicoⓘ para el archivo de Amazon S3
Para utilizar la API de correo electrónico en un archivo de Amazon S3, usted puede utilizar el siguiente punto de enlace:
POST /emailFinderS3file
API URL: https://bulkapi.zerobounce.net/emailFinderS3file
Parámetros del cuerpo:
Parameter
Description
api_key
Su clave API, que se encuentra en su cuenta. (Requerida)
file_name
La ruta completa del archivo desde su cubo de Amazon S3, según lo suministrado por /listS3files. (Requerido)
has_header_row
Verdadero si la primera fila del archivo enviado es una fila de encabezado; de lo contrario, falso. (Requerido)
remove_duplicates
Verdadero si desea que el sistema elimine los correos electrónicos duplicados; de lo contrario, falso (por defecto, verdadero). Tenga en cuenta que, si eliminamos más del 50% de las líneas debido a valores duplicados (parámetro verdadero), el sistema arrojará un error de solicitud incorrecta 400 como red de seguridad para informarle que se ha modificado más del 50% del archivo. (Opcional)
return_url
El URL se utilizará para callback cuando se haya completado la validación. (Opcional)
RESPUESTA DE PUNTO FINAL
Respuesta exitosa
Respuesta de error
Búsqueda de dominio en el archivo de Amazon S3
Para utilizar la API de búsqueda de dominio en un archivo de Amazon S3, usted puede utilizar el siguiente punto de enlace:
POST /domainSearchS3file
API URL: https://bulkapi.zerobounce.net/domainSearchS3file
Parámetros del cuerpo:
Parameter
Description
api_key
Su clave API, que se encuentra en su cuenta. (Requerida)
file_name
La ruta completa del archivo desde su cubo de Amazon S3, según lo suministrado por /listS3files. (Requerido)
has_header_row
Verdadero si la primera fila del archivo enviado es una fila de encabezado; de lo contrario, falso. (Requerido)
remove_duplicates
Verdadero si desea que el sistema elimine los correos electrónicos duplicados; de lo contrario, falso (por defecto, verdadero). Tenga en cuenta que, si eliminamos más del 50% de las líneas debido a valores duplicados (parámetro verdadero), el sistema arrojará un error de solicitud incorrecta 400 como red de seguridad para informarle que se ha modificado más del 50% del archivo. (Opcional)
return_url
El URL se utilizará para callback cuando se haya completado la validación. (Opcional)
RESPUESTA DE PUNTO FINAL
Respuesta exitosa
Respuesta de error
Exportar archivo de Amazon S3
Este punto de enlace debe ser llamado para exportar un archivo nuevamente hacia el cubo de Amazon S3. En el caso de que se haya suministrado el cubo de exportación, se sobrescribirá el cubo guardado en nuestra base de datos. De lo contrario, utilizaremos el de nuestros ajustes. Debe mencionarse que funciona tanto para archivos validados como para archivos calificados.
POST /exportS3file
API URL: https://bulkapi.zerobounce.net/exportS3file
Parámetros del cuerpo:
Parameter
Description
api_key
Su clave API, que se encuentra en su cuenta. (Requerida)
file_id
El ID del archivo validado/calificado (obligatorio).
export_bucket
Su cubo de exportación; en el caso de que no se suministre aquí, usaremos el que haya suministrado en los ajustes de la IU. (Opcional)
