Pular para o conteúdo principal

Chaves de integração

Uma chave de integração é o "usuário de API" de uma empresa: serve para ligar o Botzetta ao n8n, Make, Zapier ou ao ERP da própria empresa, sem publicar um app. Ela não é de parceiro: quem cria é o administrador da empresa, em Configurações › Chaves de integração no Botzetta.

App de parceiroChave de integração
Para quemMuitas empresas (você distribui)Uma empresa (a dona da chave)
Quem criaVocê, no portalO admin da empresa, no Botzetta
AutenticaçãoOAuth por instalação, tokens de 1 horaAuthorization: Bearer bzk_live_…, sem renovação
Tela e menu no BotzettaSimNão
WebhooksSimNão
realtime:emitir, notificacoes:enviarSimNão

Se você é um parceiro que atende várias empresas, crie um app. Pedir a chave de integração de cada cliente espalha segredos de longa duração e não dá à empresa a tela de consentimento nem o controle de desinstalação.

Usar uma chave​

GET https://api.botzetta.com/plataforma/v1/pessoas?pagina=1
Authorization: Bearer bzk_live_…
  • A empresa e os escopos são os da chave, escolhidos pelo admin na criação (e editáveis depois).
  • Validade: sem prazo ou até a data escolhida. Revogada, expirada ou inexistente → 401 ERR_TOKEN_INVALIDO, já na requisição seguinte. Regenerar troca o segredo e o antigo para na hora.
  • Limites: 600 requisições por minuto e Idempotency-Key por chave. Envios para número avulso somam até 200 por dia entre todas as chaves da empresa.
  • O recurso depende do plano da empresa (403 ERR_PLANO_SEM_RECURSO).

Os endpoints, erros e convenções são os mesmos de Chamar a API. Na Referência da API, o esquema de segurança chaveIntegracao indica onde a chave é aceita.