Documentação / Guias

Primeiros passos

Crie seu token e faça a primeira consulta.

Este guia usa a consulta de um CEP para validar a autenticação e o formato da resposta antes de conectar a API ao seu sistema.

1. Crie sua conta e obtenha um token

Crie uma conta gratuita e acesse a área de chaves de API no painel. Gere uma chave e guarde-a no servidor da sua aplicação.

2. Execute a primeira consulta

No terminal, substitua SEU_TOKEN pelo token obtido no painel e execute:

cURL
curl --request GET 'https://api.nextapi.com.br/v1/ceps/01001000' \
  --header 'Authorization: Bearer SEU_TOKEN' \
  --header 'Accept: application/json'

Uma resposta HTTP 200 indica sucesso. O JSON contém os campos descritos na referência de consulta de CEP, como cep, logradouro, uf e codigoIbge. Alguns campos podem ser nulos.

A consulta de CEP por número consome 1 crédito no plano gratuito e é isenta nos planos pagos. Os limites por minuto continuam aplicáveis.

3. Integre no backend da sua aplicação

Exemplo para Node.js com o token em uma variável de ambiente do seu servidor:

JavaScript · Node.js
const token = process.env.NEXTAPI_TOKEN;
if (!token) throw new Error('Configure NEXTAPI_TOKEN no servidor');

const response = await fetch('https://api.nextapi.com.br/v1/ceps/01001000', {
  headers: { Authorization: `Bearer ${token}`, Accept: 'application/json' },
  signal: AbortSignal.timeout(15000),
});

if (!response.ok) {
  const detail = await response.text();
  throw new Error(`NextAPI: HTTP ${response.status} - ${detail}`);
}
const address = await response.json();
console.log(address);

4. Escolha a próxima consulta

Se a chamada falhar, veja o guia de erros. Os exemplos não executam consultas automaticamente nem solicitam seu token neste site.

Fale com a gente!