Chaves de API

As chaves de API permitem que sistemas externos transmitam dados para o Waizer ou acessem os recursos da plataforma de forma programática, eliminando a dependência de autenticação manual por interface. Elas constituem o pilar central para a Integração via API.

Governança de Credenciais

O ciclo de vida das credenciais é centralizado no menu Configurações da organização → Chaves de API.

Restrição de Acesso

A criação, edição e revogação de tokens de API são atribuições exclusivas de usuários configurados com o papel de Admin da organização.

Criando uma Chave de API

1. Acesse o painel de credenciais e clique em Nova chave de API.
2. Atribua um nome descritivo e objetivo que identifique claramente a aplicação ou o ambiente de destino (ex: bot-atendimento-producao, pipeline-ci-staging).
3. Clique em Criar.
4. Copie o token gerado imediatamente. Por questões de segurança, a chave criptográfica será exibida apenas esta vez. Após fechar o modal, não será possível recuperá-la ou visualizá-la novamente.

Exibição Única

Armazene a chave em um ambiente seguro, como um gerenciador de segredos (Secret Manager) ou como variável de ambiente criptografada no seu servidor. Caso o token seja perdido, será necessário gerar uma nova credencial e atualizar todas as pontas da integração.

Diretrizes de Segurança

Para mitigar riscos de exposição e garantir a integridade dos dados trafegados, siga estas boas práticas:

• Segregação de Escopo (Um token por sistema): Aloque uma chave distinta para cada microserviço, cliente ou ambiente operacional (production, staging, development). Caso uma credencial seja comprometida, a revogação será isolada e não interromperá outros fluxos de integração.
• Isolamento de Código Frontend: Chaves de API do Waizer devem operar estritamente em ambiente server-side (backends, workers, servidores de mensageria). Nunca exponha esses tokens em códigos executados no navegador do cliente (client-side).
• Bloqueio de Commits: Jamais armazene credenciais hardcoded em repositórios de código. Utilize arquivos de configuração local (como .env) e certifique-se de incluí-los explicitamente no arquivo .gitignore do seu projeto.
• Monitoramento Ativo: Monitore a volumetria e a frequência de requisições. Diante de qualquer comportamento ou chamada inesperada na API, invalide o token imediatamente.

Manutenção e Modificações

Renomeando uma Chave

Para alterar o rótulo de identificação de uma credencial, clique diretamente sobre o nome dela na listagem do painel. Esta alteração é puramente descritiva: ela não modifica o valor criptográfico do token e não invalida as integrações ativas.

Revogando uma Chave

Para invalidar um acesso de forma definitiva, expanda o menu de contexto ⋮ localizado ao lado da credencial correspondente e selecione a opção Revogar.

Impacto Imediato

A revogação de uma chave de API é instantânea e irreversível. Qualquer aplicação que utilize o token desativado perderá o acesso aos endpoints do Waizer no mesmo segundo. Certifique-se de atualizar as variáveis dos seus servidores antes de concluir a exclusão.

Auditoria Periódica

Mantenha a listagem de chaves da organização estritamente saneada. Identifique e remova credenciais que apresentem descrições ambíguas ou cujo uso atual não possa ser mapeado pela equipe de engenharia. Tokens órfãos ou sem uso ativo representam uma superfície de ataque desnecessária.

Rotina de Segurança

Recomendamos estabelecer uma rotina de auditoria visual e revisão da lista de chaves a cada 3 meses.