Comece pelo acesso
Solicite à equipe um token de avaliação e as condições adequadas à sua aplicação. A credencial deve permanecer no servidor da sua aplicação.
Solicitar token de avaliação ↗
Consulta por CEP
Endpoint: POST https://consulta.zipdata.com.br/search/unique
Envio: application/x-www-form-urlencoded
| Parâmetro | Obrigatório | Valor |
|---|---|---|
type | Sim | api |
token | Sim | Credencial fornecida pela equipe |
cep | Sim | CEP com oito números |
return | Sim | acento |
Exemplo em PHP
O exemplo faz a chamada no servidor e verifica a conexão, o código HTTP e o JSON retornado.
<?php
// Execute no servidor. O token não deve ficar no navegador.
$token = getenv('ZIPDATA_TOKEN');
if (!$token) {
throw new RuntimeException('Configure ZIPDATA_TOKEN.');
}
$dados = [
'type' => 'api',
'token' => $token,
'cep' => '01001000',
'return' => 'acento'
];
$ch = curl_init('https://consulta.zipdata.com.br/search/unique');
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => http_build_query($dados),
CURLOPT_HTTPHEADER => [
'Content-Type: application/x-www-form-urlencoded',
'Accept: application/json'
],
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CONNECTTIMEOUT => 5,
CURLOPT_TIMEOUT => 15,
CURLOPT_SSL_VERIFYPEER => true,
CURLOPT_SSL_VERIFYHOST => 2
]);
$resposta = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($resposta === false || $status < 200 || $status >= 300) {
throw new RuntimeException('Falha ao consultar a API.');
}
$resultado = json_decode($resposta, true, 512, JSON_THROW_ON_ERROR);
// Interprete os campos conforme o retorno efetivo do serviço.
Pesquisa por endereço
Para buscar por logradouro, cidade e UF, utilize POST /search/multiple. Envie type, token, street, city, uf e return=acento. Bairro (district) e CEP (cep) podem refinar a pesquisa.
Do retorno ao mapa
Use o par de latitude e longitude fornecido pelo serviço para posicionar um marcador no mapa. Confira os nomes, a estrutura e a precisão dos campos na resposta efetiva da sua contratação.
Prepare o tratamento de erros
- Valide o CEP antes de enviar a consulta.
- Defina um tempo limite para a conexão e a resposta.
- Verifique o status HTTP e se o conteúdo é JSON válido.
- Trate consultas sem resultado e respostas sem coordenadas.
- Mantenha a credencial protegida e respeite os limites de uso do serviço.
Referência: manual público da API ZipData, versão 1.2, outubro de 2026. Para acesso e detalhes do retorno real, fale com vendas@basepostal.com.br.