API Keys

A API Key identifica sua conta nas chamadas à API pública.

Onde fica no painel

• Menu lateral: API Keys
• Rota: https://buscaprocessos.app.br/dashboard/keys
• Título da tela: API Keys
• Subtítulo: segurança de acesso e credencial no header da API

Pré-requisitos

• Pacote de créditos da API contratado em Planos da API (checkout em /contratar?produto=api)
• Acesso liberado ao painel após pagamento (e definição de senha, quando o checkout solicitar)
• Conta ativa
• Sem bloqueio de geração por restrição antifraude

Se o e-mail não estiver confirmado, o backend devolve mensagem pedindo confirmação antes de visualizar ou gerar a chave.

Como gerar

1. Acesse API Keys.
2. Clique em Nova chave (botão superior) ou Gerar nova chave (tabela).
3. No modal:
   • Título: Gerar API key (primeira vez) ou Gerar nova chave (rotação)
   • Texto informa que a credencial fica salva na conta corporativa
   • Se já existir chave, aviso em destaque: a anterior será invalidada imediatamente
4. Clique em Gerar chave (ou Cancelar).
5. Feedback de sucesso:
   • API key gerada com sucesso.
   • ou Nova API key gerada. A chave anterior foi substituída.

Não há formulário de nome, escopo ou expiração na UI. O nome exibido é fixo: BuscaProcessos API.

Como visualizar e copiar

• Por padrão a chave fica oculta (máscara no painel).
• Ícone de olho: Revelar chave / Ocultar chave
• Ícone de copiar: Copiar chave
• Feedback: API key copiada para a área de transferência.

📘

A chave não é do tipo “mostre uma única vez e desapareça”.
Ela permanece armazenada na conta e pode ser revelada novamente no painel.

Como revogar

1. Na linha da chave, clique em Revogar.
2. Confirme no modal Revogar chave com Confirmar revogação.
3. Feedback: API key revogada com sucesso.

Após a revogação, chamadas com a chave antiga retornam INVALID_API_KEY.

Como rotacionar

Rotacionar = gerar nova chave. A operação substitui a anterior de imediato.

Fluxo recomendado:

1. Atualize o secret no backend com a nova chave.
2. Só então remova a chave antiga dos ambientes antigos (já invalidada no servidor).
3. Monitore 401 INVALID_API_KEY em serviços ainda não atualizados.

Formato

bp_live_<40_hex>

Exemplo fictício:

bp_live_0123456789abcdef0123456789abcdef01234567

Geração após a contratação

Após contratar o pacote de créditos e acessar o painel, use API Keys para gerar, copiar, rotacionar ou revogar a chave.

A chave só é utilizável na API pública com conta ativa, e-mail confirmado e saldo disponível para as operações cobradas.

Uso na requisição

curl --request GET \
  --url 'https://api.buscaprocessos.app.br/v1/processos?cpf_cnpj=00000000000' \
  --header "x-api-key: ${BUSCAPROCESSOS_API_KEY}"

Também é aceito:

Authorization: Bearer ${BUSCAPROCESSOS_API_KEY}

Boas práticas

• Uma chave por conta; não compartilhe entre empresas diferentes.
• Armazene apenas em backend/secret manager.
• Nunca coloque a chave em repositório Git, Postman públicos, frontend ou mobile.
• Rotacione após vazamento ou saída de colaborador com acesso ao secret.
• Use o Playground do painel apenas em contexto controlado (consome créditos reais).

Endpoints internos do painel (não são API pública)

Essas rotas exigem sessão do dashboard (Authorization: Bearer do login), não a API Key pública.

Limites e escopos

Próximos passos

• Autenticação
• Primeira requisição
• Segurança