Acesso à API (para desenvolvedores)

Configurações → Integrações (/app/settings/integrations), cartão Acesso à API (para desenvolvedores), no fim da página. Apenas proprietários e administradores. "Conecte o OmniBrand aos seus próprios sistemas, ao Zapier ou ao Make para criar posts, adicionar contatos ou ler análises automaticamente." Uma chave permite que seu próprio software chame a API pública do OmniBrand com o cabeçalho Authorization: Bearer ob_live_… A parte de baixo do cartão, Endpoint da API, mostra o endereço para onde enviar essas requisições ("O endereço pelo qual a API pública responde. Envie cada requisição para lá, com uma das chaves acima."). Links antigos para /app/settings#developer abrem este cartão.

Quais planos incluem

O acesso à API faz parte dos planos Agency e Enterprise. No Grátis, no Starter e no Pro, e durante o teste do Pro de 14 dias, o cartão mostra apenas "O acesso à API está disponível no plano Agency." com um link Ver planos para Plano e uso; não há formulário de chaves. Os cartões de plano em Plano e uso e em /pricing mostram Acesso à API para Agency e Enterprise.

Quando o plano muda

• Quando a conta passa para um plano sem acesso à API (um downgrade, um reembolso ou o fim de um teste), as chaves ficam pausadas: continuam guardadas e nada é apagado, mas cada chamada feita com elas é recusada com "API access is available on the Agency and Enterprise plans. Upgrade under Settings > Plan & usage to use API keys." (HTTP 403, código api_access_not_in_plan).
• O proprietário da conta recebe um único e-mail, Your API keys are paused ("Suas chaves de API estão pausadas porque seu plano não inclui mais acesso à API…"), com um botão Ver planos.
• Voltar para Agency ou Enterprise reativa as mesmas chaves em até um minuto. Não é preciso criar chaves novas.
• Enquanto pausadas, as chaves não aparecem na lista e não podem ser criadas nem rotacionadas. Para encerrar uma chave de vez, volte a um plano com acesso à API e clique em Revogar, ou fale com o suporte.

Passo a passo: crie uma chave

1. Digite um nome em Nome da chave (por exemplo, CI bot), com até 60 caracteres, para saber depois o que o utiliza. Sem nome (ou apenas espaços), Criar chave não cria nada e a caixa diz "Dê um nome à chave, por exemplo "Website sync"." Espaços antes e depois do nome são removidos.
2. Em Escopos da chave, escolha somente leitura (dados de leitura) ou leitura + escrita (também criando e mudando coisas).
3. Clique em Criar chave.
4. Uma caixa amarela mostra "Nova chave para "(nome)". Copie agora: ela é mostrada apenas uma vez." e a chave completa, com Copiar (então diz Copiado) e Já salvei, que fecha a caixa. Copie a chave agora e guarde-a em um lugar seguro; A 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: pergunta antes: "Rotacionar "(nome)" (prefixo…)? Você recebe uma nova chave na hora. A chave atual continua funcionando por 24 horas e depois para, então coloque a nova chave em todos os lugares onde a antiga é usada antes disso." Clique em Rotacionar chave para continuar ou em Cancelar. A nova chave, com o mesmo nome e escopo, é mostrada uma única vez na mesma caixa amarela. A chave antiga continua funcionando por 24 horas, para você migrar sua integração, e depois para. Até lá, ela continua na lista, sem riscado, com "Chave antiga funciona até [data e hora]" e um botão Revogar.
• Revogar: pergunta "Revogar a chave (nome) (prefixo…)? Tudo o que a usa para de funcionar na hora, e uma chave revogada não pode ser reativada." A janela tem o título Revogar chave?; clique em Revogar chave para interromper a chave na hora ou em Cancelar para mantê-la. Isso também funciona em uma chave antiga durante as 24 horas após uma rotação: se você rotacionou porque a chave vazou, clique em Revogar na chave antiga para que ela pare agora. Chaves revogadas (e chaves rotacionadas depois que as 24 horas terminam) ficam na lista, riscadas, com um rótulo vermelho "Revogada em (data)" abaixo do nome.

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 espaços de trabalho 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 espaços de trabalho. 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

• "This API key has expired. Rotate it under Settings > Integrations > API access.": as chaves duram um ano. Clique em Rotacionar na chave em Acesso à API (para desenvolvedores) (ou crie uma nova) e atualize 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.
• "Este endpoint não está disponível para chaves de API": essa chamada é só para uma pessoa conectada, qualquer que seja o escopo da chave. Uma chave nunca tem acesso a: membros e convites (/workspaces/{id}/members, /workspaces/{id}/invitations, /invitations), criar, renomear, arquivar, desarquivar ou excluir um espaço de trabalho, webhooks de saída (/workspaces/{id}/webhooks), exportações, a cadeia de aprovação, agendamentos de relatórios, conectar, desconectar ou remover um canal ou trocar o dono dele, o logo, o perfil e o onboarding da organização, e qualquer coisa em /auth, /billing, /admin ou /tenant/api-keys. Faça isso no app, conectado como proprietário ou administrador. A IA por chave cobre texto de publicações, ideias, imagens, reescritas, hashtags, texto alternativo e triagem de mensagens, até 10 chamadas por minuto e 300 por dia por chave ("API key AI rate limit exceeded"); vídeo, AI Studio e os demais assistentes de IA são só para pessoas com sessão iniciada. As tarefas, fontes e configurações do Market Watch, os bots e as configurações do espaço de trabalho, como a triagem automática, também só podem ser alterados por uma pessoa com sessão iniciada. Ativar ou desativar o suporte, alterar a classificação por IA e a leitura por IA do Brand Health também exigem uma pessoa com sessão iniciada, e um relatório pedido com uma chave só inclui um resumo de IA se ele já existir.

Relacionado

• Planos
• Integrações: webhooks de saída
• Papéis e permissões
• A página de Configurações