API Keys
A API Key identifica sua conta nas chamadas à API pública.
Ela é o ponto de partida para levar consultas ao seu produto ou automação. Uma única credencial usada em ambiente seguro permite centralizar o acesso sem expor dados de autenticação aos usuários finais.
O que ela viabiliza
- integrar dados processuais ao sistema que sua equipe já utiliza;
- automatizar consultas sem intervenção manual no painel;
- controlar acesso e rotação da integração em um ponto único;
- rastrear consumo e requisições vinculadas à conta;
- evoluir da primeira consulta para monitoramentos, webhooks e rotinas recorrentes.
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
- Conta no plano Free ou em um plano pago da API. Crie sua conta Free ou consulte os planos.
- Acesso ao Console API e e-mail confirmado
- Conta ativa
- Sem bloqueio de geração por restrição antifraude
Confirme o e-mail da conta antes de visualizar ou gerar a chave.
Como gerar
- Acesse API Keys.
- Clique em Nova chave (botão superior) ou Gerar nova chave (tabela).
- 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
- Clique em Gerar chave (ou Cancelar).
- Feedback de sucesso:
API key gerada com sucesso.- ou
Nova API key gerada. A chave anterior foi substituída.
O nome exibido é BuscaProcessos API. A chave não possui escopos ou data de expiração configuráveis no Console 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
- Na linha da chave, clique em Revogar.
- Confirme no modal Revogar chave com Confirmar revogação.
- 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:
- Atualize a chave em todos os ambientes que usam a API.
- Verifique se as integrações voltaram a responder normalmente.
- Monitore respostas 401
INVALID_API_KEYem integrações que ainda não foram atualizadas.
Formato
bp_live_<40_hex>
Exemplo fictício:
bp_live_SUA_CHAVE
Geração após a contratação
Após criar sua conta Free ou contratar um plano pago 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 no servidor ou em um gerenciador de segredos.
- Nunca coloque a chave em repositórios, coleções públicas, frontend ou aplicativos móveis.
- Rotacione após vazamento ou saída de colaborador com acesso à credencial.
- Use o Playground do painel apenas em contexto controlado (consome créditos reais).
Limites e escopos
| Item | Situação atual |
|---|---|
| Múltiplas chaves ativas | Não (uma por conta) |
| Nome customizado | Não |
| Escopos/permissões por chave | Não |
| Data de expiração da chave | Não configurável no Console API |