Chaves API para desenvolvedores

Criar chaves de leitura ou leitura + escrita para a API pública; uma chave pertence ao administrador que a criou e para de funcionar se este parar de administrar seus workspaces.

Configurações, seção Chaves de API para desenvolvedores (/app/settings#developer). Apenas proprietários e administradores. Uma chave permite que seu próprio software chame a API pública da OmniBrand com o cabeçalho Authorization: Bearer ob_live_...

Passo a passo: crie uma chave

  1. Digite um nome em Nome da chave (ex.: bot CI), com até 60 caracteres, para saber depois o que o utiliza.
  2. Escolha somente leitura (leitura de dados) ou leitura + escrita (também criando e mudando coisas).
  3. Clique em Criar chave.
  4. Uma caixa amarela mostra "Chave API (copiar agora - mostrada apenas uma vez):" e a chave completa. Copie agora e guarde em um lugar seguro; O OmniBrand armazena apenas uma impressão digital e nunca poderá mostrá-la novamente.

A lista

Cada tecla mostra seu nome, os primeiros caracteres (ob_live_...), seu escopo, quando foi usada pela última vez ("used ..." ou "never used") e "expira ..." com sua data de término. - Rotacionar: emite uma nova chave com o mesmo nome e escopo e a mostra uma única vez. A chave antiga continua funcionando por 24 horas para que você possa migrar sua integração e depois para. Até lá, ela fica na lista, sem tachado, com "A chave antiga funciona até {date and time}" e um botão Revogar. - Revogar: desativa a chave na hora. Isso também funciona em uma chave antiga durante as 24 horas após uma rotação: se você a rotacionou porque a chave vazou, clique em Revogar na chave antiga para que ela pare agora. Chaves revogadas (e chaves rotacionadas depois de passadas as 24 horas) ficam na lista, tachadas.

Quem possui uma chave

  • Uma chave pertence à pessoa que a criou, e cobre os espaços de trabalho onde essa pessoa é proprietária ou administradora no momento da criação.
  • Funciona apenas enquanto seu criador ainda for um proprietário ativo ou administrador de todos os workspaces que cobre. Se forem removidos, rebaixados ou seu login for desativado, as chamadas falham com "A pessoa que criou esta chave API não administra mais seus workspaces. Peça a um administrador atual para emitir uma nova chave."
  • Veja, gire e revoge apenas as chaves cujos espaços de trabalho você administra você mesmo. Em uma conta com muitos espaços de trabalho de cliente, o administrador de um cliente não pode ver as chaves de outro cliente.

Se algo der errado

  • "Esta chave de API expirou. Gire-a em Configurações > Chaves de API para desenvolvedores.": as chaves duram um ano. Clique em Rotacionar nela em Chaves de API para desenvolvedores (ou crie uma nova) e atualize a sua integração.
  • "Chave API inválida ou revogada": a chave foi revogada, sua graça de rotação de 24 horas terminou ou foi copiada incompletamente.
  • Uma chave API não pode criar, rotacionar ou revogar outras chaves; apenas uma pessoa logada pode.

Relacionado

Conferido com o produto em 23 de set. de 2026

Nesta seção: Configurações

Todos os artigos