Pular para o conteúdo principal
🤖 A Judit API NÃO utiliza o padrão Authorization: Bearer <token>. A autenticação é feita exclusivamente através da passagem da chave no cabeçalho HTTP customizado chamado api-key. Isso se aplica a todos os endpoints e URLs Base da Judit.

1. Como Obter sua API Key

Sua API Key é a credencial única que vincula suas requisições à sua conta e plano contratado.
  1. Entre em contato com nossa equipe comercial via WhatsApp.
  2. Forneça o contexto: Explique seu caso de uso e volume esperado de requisições.
  3. Receba a Chave: Sua API Key será enviada de forma segura para o e-mail cadastrado.
⚠️ Segurança em 1º Lugar: Considere sua API Key como uma senha em texto claro. Nunca a exponha em repositórios públicos (ex: GitHub), código front-end (navegador do cliente) ou aplicativos mobile sem ofuscação.

2. Padrão de Autenticação (Header api-key)

Em todas as requisições feitas para a Judit API, independentemente do serviço ou módulo (Consultas, Monitoramento, etc.), você deve incluir o cabeçalho api-key.

Exemplo de Requisição HTTP Básica

Exemplos Práticos de Implementação

Abaixo, mostramos como realizar uma requisição autenticada utilizando a URL Base de Consultas Assíncronas (https://requests.production.judit.io), consumindo a chave a partir de variáveis de ambiente.

3. Gestão Segura e Boas Práticas

Para evitar o vazamento da sua credencial, consolide a gestão da sua chave seguindo estas regras:

1. Uso Exclusivo de Variáveis de Ambiente

Nunca hardcode sua API Key no código:

2. Configure Variáveis de Ambiente

Linux/macOS:
Windows:
Docker:

3. Arquivo .env (Desenvolvimento)

4. Rotação de Chaves

  • Monitore o uso de sua API Key regularmente
  • Solicite nova chave se suspeitar de comprometimento
  • Implemente rotação implementação em ambientes críticos

Tratamento de Erros de Autenticação

Erro 401 - Unauthorized

Possíveis causas:
  • API Key não fornecida
  • API Key inválida ou expirada
  • Header api-key mal formatado
  • Limite de uso excedido

Erro 403 - Forbidden

Possíveis causas:
  • API Key válida mas sem permissão para o recurso
  • Recurso não disponível no seu plano

Validação da API Key

Teste de Conectividade

Monitoramento de Uso

Configuração por Ambiente

Classe de Configuração

Próximos Passos

Suporte: Em caso de problemas com autenticação, entre em contato com nosso suporte técnico.