API de envío de archivos por correo electrónico y móvil
La API de envío de archivos Captain Verify es la solución ideal para empresas y desarrolladores que buscan optimizar sus campañas de marketing y mejorar la calidad de su base de datos. Al integrar esta API en sus herramientas existentes, puede aprovechar completamente las características de verificación avanzadas de Captain Verify, mientras disfruta del tiempo y una mejor productividad. Gracias a nuestra API, puede enviar archivos (CSV, TXT) que contienen direcciones de correo electrónico o números móviles para verificar directamente desde su aplicación o plataforma, sin tener que pasar por el tablero. Nuestra infraestructura garantiza un procesamiento rápido y seguro de sus archivos.
Clave API
Es necesaria una cuenta para generar la clave para la API, esto es lo que le dará acceso al servicio..
Límites de API
La API se limita a un archivo 1 mediante verificación.
Puede poner hasta 1 millón de líneas por archivo de correo electrónico y 100,000 líneas por archivo de número de móvil. (20mo max)
Asegúrese de que su aplicación no exceda estos límites.
Lista de archivos
Para recuperar la lista de archivos y estado:
curl -X GET "https://api.captainverify.com/file/?apikey=APIKEY"
[{
"id":"21446",
"type":"email",
"name":"file1.txt",
"status":"done"
},{
"id":"21218",
"type":"mobile",
"name":"file2.txt",
"status":"ready"
}]
Estado | Descripciones |
---|---|
file validation | El archivo está en importación y validación a Captain Verify |
ready | El archivo está listo para la verificación |
invalid | El archivo no es válido |
processing | El archivo está en el patio de verificación |
done | La verificación se completa, el archivo se puede descargar |
Iniciar un cheque
Para iniciar una verificación de archivo "ready" :
curl -X PUT "https://api.captainverify.com/file/21218?apikey=APIKEY"
⚠️ El archivo debe estar en el estado "ready".
"21218" es un ejemplo y debe ser reemplazado por la identificación de su archivo.
Respuestas | Descripciones |
---|---|
success | [ 'status' => 'file #21218' sent for mobile validation' ] |
not enough credits | [ 'error' => 'not enough credit' ] |
Enviar un archivo
Para enviar un archivo (TXT, CSV) :
Para un archivo de correo electrónicocurl -X POST -F file=@file1.txt "https://api.captainverify.com/file/email?apikey=APIKEY"
file1.txt es el nombre del archivo local.
Para un archivo móvilcurl -X POST -F file=@file2.txt "https://api.captainverify.com/file/hlr?apikey=APIKEY"
file2.txt es el nombre del archivo local.
Respuestas | Descripciones |
---|---|
success response | [ 'status' => 'file file2.txt received' ] |
Eliminar un archivo
Para eliminar un archivo :
curl -X DELETE "https://api.captainverify.com/file/21218?apikey=APIKEY"
21218 es un ejemplo y debe ser reemplazado por la identificación de su archivo que desea eliminar.
⚠️ El estado del archivo debe estar: ready, invalid, done, para ser eliminado.
Descargue los resultados de una verificación
Para descargar los resultados de una verificación, tiene 3 archivos disponibles : all, ok y marketing* (Más información en la documentación). 2 formatos de archivo están disponibles : CSV o XLSX.
curl -X GET --output ok.csv "https://api.captainverify.com/file/21218/ok?apikey=APIKEY&ext=xlsx"
21218 es un ejemplo y debe ser reemplazado por la identificación de su archivo.
&ext=xlsx es el formato de archivo de forma predeterminada, puede reemplazarlo con &ext=csv Para cambiar el formato CSV.
*El archivo de marketing solo está disponible para nuevos archivos verificados.
Errores
En caso de error :
Respuestas | Descripciones |
---|---|
error response | [ 'error' => ‘xxxxxxxxxxx’ ] |