Documentação da API

Integre consultas empresariais com uma API clara, estável e pronta para produção.

A API do GuiaPJ centraliza consulta de CNPJ, busca estruturada e recursos de prospecção com exemplos práticos, regras de autenticação e referências objetivas para acelerar a integração.

AutenticaçãoLimitesEndpointsCache

Guia rápido

Comece aqui

Comece pela documentação, teste os fluxos públicos e use os exemplos abaixo para levar a consulta empresarial ao seu produto, operação interna ou jornada comercial.

Teste online Ver ficha de empresa Pesquisa avançada

Autenticação

Authorization

Envie sua chave no cabeçalho Authorization: Bearer SUA_CHAVE em todas as chamadas autenticadas.

Exemplo de consultaBASH

curl -X GET "https://api.guiapj.com.br/api/empresa/12345678000195"   -H "Authorization: Bearer sk_live_sua_chave"

Limites de utilização

Rate limit

Créditos

Defina políticas de consumo por tipo de consulta para manter previsibilidade operacional e financeira.

Taxa por minuto

Estabeleça limites por minuto para preservar performance e estabilidade em cenários de alto volume.

Cache

Adote cache para reduzir latência, otimizar custos e responder mais rápido a consultas recorrentes.

Endpoints principais

Preview

GET

/api/empresa/[cnpj]

Retorna a ficha cadastral principal do estabelecimento.

GET

/api/busca-simples

Busca por nome, fantasia, sócio ou CNPJ com resposta curta para navegação rápida.

GET

/api/busca-seo

Busca indexável por nome, UF, município, CNAE e CEP.

POST

/api/pesquisa-avancada

Recebe filtros complexos de prospecção e devolve uma lista comercial estruturada.

POST

/api/certificado/emitir

Gera token assinado para validação pública de comprovante.

GET

/api/health

Endpoint de verificação para monitoramento da disponibilidade do serviço.

Exemplos práticos

cURL + JSON

Busca SEOBASH

curl "https://api.guiapj.com.br/api/busca-seo?q=mercado&uf=SP"

Pesquisa avançadaJSON

{
  "razao": "mercado",
  "uf": "SP",
  "situacao": "02",
  "cnae": ["4711302"]
}

Estratégia de cache

Recomendado

Para equilibrar custo, velocidade e atualidade dos dados, recomenda-se trabalhar com três estratégias: CACHE, CACHE_IF_FRESH e ONLINE.

CACHE

Entrega apenas dados armazenados localmente, ideal para tráfego alto e custo menor.

CACHE_IF_FRESH

Retorna cache recente e recorre à fonte online só quando a informação estiver vencida.

ONLINE

Consulta direto a fonte, útil para cenários críticos, mas com maior custo operacional.