Criar um lote
curl --request POST \ "https://api.iporto.com.br/api/external/v1/email-validation-batches" \ --header "Authorization: Bearer $IPORTO_API_KEY" \ --header "Content-Type: application/json" \const resposta = await fetch("https://api.iporto.com.br/api/external/v1/email-validation-batches", { method: "POST", headers: { Authorization: `Bearer ${process.env.IPORTO_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ "name": "Carrinho abandonado", "emails": [ ] }),});
console.log(await resposta.json());$client = new \GuzzleHttp\Client();
$resposta = $client->post('https://api.iporto.com.br/api/external/v1/email-validation-batches', [ 'headers' => ['Authorization' => 'Bearer '.getenv('IPORTO_API_KEY')], 'json' => ['name' => 'Carrinho abandonado', 'emails' => ['[email protected]', '[email protected]']],]);
print_r(json_decode((string) $resposta->getBody(), true));import osimport requests
url = 'https://api.iporto.com.br/api/external/v1/email-validation-batches'headers = {'Authorization': 'Bearer ' + os.environ['IPORTO_API_KEY']}
resposta = requests.post(url, headers=headers, json={"name":"Carrinho abandonado","emails":["[email protected]","[email protected]"]})
print(resposta.json())Aceita arquivo (multipart/form-data, campo file, .csv ou .txt) ou uma lista JSON.
A resposta é 201 com o identificador e os contadores zerados: um arquivo grande não cabe no tempo de uma requisição. Acompanhe em GET /email-validation-batches/{id}.
⚠️ Quem encerra é status (completed ou failed), não progress.
Authorizations
Seção intitulada “Authorizations”Request Bodyrequired
Seção intitulada “Request Bodyrequired”object
object
Examplegenerated
{ "name": "example", "emails": [ "example" ]}Responses
Seção intitulada “Responses”O lote foi aceito e entrou na fila.
Um lote de verificação. totals conta linhas e andamento; results conta o que o motor achou, e pode trazer null em qualquer campo — nulo é “não sabemos”.
object
object
object
object
Examplegenerated
{ "object": "example", "id": "example", "name": "example", "source": "example", "origin": "example", "status": "example", "progress": 1, "totals": { "lines": 1, "emails": 1, "duplicated": 1, "pending": 1, "completed": 1, "failed": 1, "insufficient_credits": 1 }, "results": { "valid": 1, "invalid": 1, "unknown": 1, "deliverable": 1, "risky": 1, "undeliverable": 1, "unverified": 1, "disposable": 1, "gibberish": 1, "typing_error": 1, "trap": 1, "abandoned": 1, "free": 1, "role": 1, "name": 1, "bank": 1, "gov": 1, "catch_all": 1 }, "credits_charged": 1, "file": { "size_bytes": 1, "mime_type": "example" }, "error": "example", "created_at": "example", "started_at": "example", "completed_at": "example", "expires_at": "example", "items_pruned_at": "example"}A chave não foi enviada, ou venceu.
object
Examplegenerated
{ "error": "example"}Sem crédito para a quantidade de endereços do lote.
object
Examplegenerated
{ "error": "example"}O arquivo ou a lista passou do teto. A mensagem traz o limite e o tamanho recebido — é 413, e não 422, porque o pedido está correto: só é grande demais.
object
Examplegenerated
{ "error": "example"}Nem file nem emails vieram, ou a extensão não é .csv/.txt.
object
Examplegenerated
{ "error": "example"}Não foi possível consultar o saldo. Tente de novo.
object
Examplegenerated
{ "error": "example"}