API de envio de arquivo: um ativo para suas listas

API de envio de arquivo por email e celular

A API de envio de arquivos Captain Verify é a solução ideal para empresas e desenvolvedores que procuram otimizar suas campanhas de marketing e melhorar a qualidade de seu banco de dados. Ao integrar essa API às suas ferramentas existentes, você poderá aproveitar completamente os recursos avançados de verificação do Captain Verify, enquanto aproveitam o tempo e a melhor produtividade. Graças à nossa API, você pode enviar arquivos (CSV, TXT) contendo endereços de email ou números de celular para verificar diretamente do seu aplicativo ou plataforma, sem precisar passar pelo painel. Nossa infraestrutura garante processamento rápido e seguro de seus arquivos.

Chave API

É necessária uma conta para gerar a chave para a API, é isso que lhe dará acesso ao serviço.

Limites da API

A API é limitada a um arquivo 1 por verificação.
Você pode colocar até 1 milhão de linhas por arquivo de email e 100.000 linhas por arquivo de número de celular. (20mo max)
Verifique se o seu aplicativo não excede esses limites.

Arquivos de lista

Para recuperar a lista de arquivos e status:

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"
}]

Status	Descrições
file validation	O arquivo está em importação e validação para Captain Verify
ready	O arquivo está pronto para verificação
invalid	O arquivo não é válido
processing	O arquivo está no pátio de verificação
done	A verificação é concluída, o arquivo pode ser baixado

Inicie um cheque

Para iniciar uma verificação de arquivo "ready" :

curl -X PUT "https://api.captainverify.com/file/21218?apikey=APIKEY"

⚠️ O arquivo deve estar no status "ready".
"21218" é um exemplo e deve ser substituído pelo ID do seu arquivo.

Respostas	Descrições
success	[ 'status' => 'file #21218' sent for mobile validation' ]
not enough credits	[ 'error' => 'not enough credit' ]

Envie um arquivo

Para enviar um arquivo (TXT, CSV) :

Para um arquivo de email

curl -X POST -F file=@file1.txt "https://api.captainverify.com/file/email?apikey=APIKEY"

file1.txt é o nome do arquivo local.

Para um arquivo móvel

curl -X POST -F file=@file2.txt "https://api.captainverify.com/file/hlr?apikey=APIKEY"

file2.txt é o nome do arquivo local.

Respostas	Descrições
success response	[ 'status' => 'file file2.txt received' ]

Exclua um arquivo

Para excluir um arquivo :

curl -X DELETE "https://api.captainverify.com/file/21218?apikey=APIKEY"

21218 é um exemplo e deve ser substituído pelo ID do seu arquivo que você deseja excluir.
⚠️ O status do arquivo deve estar: ready, invalid, done, para ser excluído.

Baixar os resultados de uma verificação

Para baixar os resultados de uma verificação, você tem 3 arquivos disponíveis: all, ok e marketing* (Mais informações na documentação). 2 formatos de arquivo estão disponíveis : CSV ou XLSX.

curl -X GET --output ok.csv "https://api.captainverify.com/file/21218/ok?apikey=APIKEY&ext=xlsx"

21218 é um exemplo e deve ser substituído pelo ID do seu arquivo.
&ext=xlsx é o formato de arquivo por padrão, você pode substituí-lo por &ext=csv Para alterar o formato CSV.

*O arquivo de marketing está disponível apenas para novos arquivos verificados.

Erros

Em caso de erro :

Respostas	Descrições
error response	[ 'error' => ‘xxxxxxxxxxx’ ]