Pular para o conteúdo

Autenticação e chaves API

Crie uma chave de API sk_ no Centro de APIs . A chave completa é exibida apenas uma vez, quando é criada ou rotacionada.

Use uma chave separada para cada aplicação, ambiente e tarefa automatizada, permitindo que cada um tenha seu próprio orçamento e seja desabilitado, rotacionado e auditado de forma independente.

Recomendado:

X-API-Key: sk_your_key

O formulário padrão Bearer também funciona:

Authorization: Bearer sk_your_key

Envie apenas um dos dois em uma solicitação.

Terminal window
curl https://omnidoc.top/api/v1/jobs \
-H "X-API-Key: $OMNIDOC_API_KEY"

Uma chave funciona para a conta que a criou: ela pode chamar os serviços que essa conta pode usar e acessar apenas os recursos dessa conta. Uma chave não pode alterar o e-mail de login, a senha, o número de telefone ou o perfil, nem pode criar, rotacionar ou revogar chaves de API.

Limites opcionais:

  • allowed_engines: apenas as configurações de tradução listadas; um array vazio não adiciona nenhum limite no nível da chave.
  • expires_at: tempo de expiração.
  • quota_limit: o orçamento de vida útil da chave em milicréditos inteiros; 0 não define um orçamento ao nível da chave, e os créditos da conta são liquidados normalmente.

Crie chaves, altere seus limites, rotacione ou revogue-as no centro da API API center . Uma vez que uma chave é revogada, desabilitada ou expirou, ou sua conta é desabilitada, novas solicitações falham imediatamente.

A rotação cria um novo segredo e desativa o antigo imediatamente; a nova chave mantém os limites originais e o orçamento já utilizado. Uma chave expirada não pode ser rotacionada; crie uma nova. Para uma troca suave, crie uma nova chave e implante-a, confirme que as chamadas são bem-sucedidas e, em seguida, revogue a chave antiga.

  • Mantenha as chaves apenas no servidor ou em um ambiente de execução controlado.
  • Use variáveis de ambiente ou um gerenciador de secrets; nunca inclua chaves no código-fonte, em logs, em pacotes do navegador ou em repositórios públicos.
  • Nunca envie a chave para os endereços de upload ou download retornados pela API.
  • Registre o ID da chave, o ID da solicitação e o ID da operação; nunca registre a chave completa.
  • Se uma chave for comprometida, rotacione-a imediatamente e revise seus trabalhos e cargas.