Criando uma chave de API

Gere, gerencie e revogue chaves de API para a API Vulgate.

21 de mai. de 2026

Chaves de API permitem que seu código se autentique no Vulgate assim como o aplicativo web faz. Cada chave tem escopo para uma única equipe / Organização e herda suas permissões.

Gerar uma nova chave

  1. Abra o aplicativo Vulgate.
  2. Na barra lateral, escolha Configurações → API.
  3. Clique em Criar uma nova chave de API.
  4. Dê à chave um nome que explique para que serve ("Produção", "CI/CD", "Dev local"). Nomes ajudam você a identificar e revogar a chave certa depois.
  5. Clique em Criar.

O Vulgate mostra o valor da chave uma vez — copie imediatamente. Nunca a exibimos novamente; a única recuperação é gerar uma nova.

Armazenando a chave

Nunca faça commit de uma chave no controle de versão. Os dois padrões seguros são:

  • Variável de ambiente no seu shell ou CI:
export VULGATE_API_KEY=...
  • Arquivo .env carregado em tempo de execução (e .env listado no seu .gitignore):
VULGATE_API_KEY=...

Então leia do seu código:

import os
api_key = os.environ["VULGATE_API_KEY"]

const apiKey = process.env.VULGATE_API_KEY!;

Usando a chave

Toda requisição precisa da chave no cabeçalho Authorization:

curl https://vulgate.ai/api/search \
  -H "Authorization: Bearer $VULGATE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "teste"}'

Listar chaves existentes

A página Configurações → API mostra todas as chaves criadas para a equipe atual, com o nome e data de criação de cada chave.

Excluir uma chave

  1. Abra Configurações → API.
  2. Encontre a chave na lista.
  3. Clique em Excluir chave de API.
  4. Confirme.

A exclusão entra em vigor em segundos. Qualquer requisição usando uma chave excluída recebe HTTP 401.

Melhores práticas para chaves

  • Uma chave por aplicativo. Misturar chaves entre aplicativos significa que você não pode revogar uma sem quebrar a outra.
  • Use nomes claros. Eles não custam nada e salvam você em um incidente.
  • Rotacione periodicamente. Gere uma nova chave, implante-a, depois exclua a antiga.
  • Mantenha chaves fora dos logs. Configure sua biblioteca de logging para ocultar cabeçalhos Authorization.

Qual escopo uma chave tem?

Cada chave de API tem escopo para uma única equipe e carrega as permissões da pessoa que a criou. Isso significa que uma chave criada por um Super Administrador pode fazer mais do que uma criada por um Desenvolvedor, e que uma chave para de funcionar quando quem a criou sai da equipe. Proprietários e Super Administradores veem todas as chaves da equipe; um Desenvolvedor vê apenas as suas.

Relacionados

Pesquisar ajuda