Chaves de API
A aba Chaves de API é onde você pode gerar e rotular chaves de API para se conectar aos recursos da plataforma de forma programática. Use essas chaves para estabelecer e manter conexões com outros serviços. Recomendamos revisar regularmente suas chaves de API e excluir as que não são mais necessárias para proteger seu projeto contra acessos não autorizados.
As chaves de API são específicas do projeto e fornecem acesso aos recursos do projeto. Mantenha-as seguras e rotacione-as regularmente.
Lista de Chaves de API
A lista de chaves de API exibe todas as chaves criadas para este projeto. Use o campo Pesquisar por nome ou chave para encontrar uma chave específica. Cada entrada exibe as seguintes colunas:
| Coluna | Descrição |
|---|---|
| Nome | O nome atribuído à chave de API, com um indicador do tipo (Privilegiada ou Sistema). |
| Chave de API | Uma pré-visualização truncada do valor da chave. Use o ícone de copiar para copiar a chave completa para sua área de transferência. |
| Criada em | A data e hora em que a chave foi criada. |
| Ações | Um link Excluir para chaves criadas pelo usuário. Chaves do sistema exibem Protegida e não podem ser excluídas. |
Tipos de Chaves
Ao criar uma nova chave de API, você deve selecionar um dos seguintes tipos de chave:
| Tipo | Descrição |
|---|---|
| Chave Privilegiada | Acesso total ao projeto. Pode enviar chats e editar ou excluir recursos do projeto, agents, workflows e configurações. Use esta chave para integrações confiáveis e automações servidor-a-servidor. |
| Chave de Visualizador Restrita | Acesso somente leitura ao projeto mais o runtime de chat (interação com bot). Não pode editar ou excluir recursos do projeto, agents, workflows ou configurações. Destinada a distribuição de escopo limitado, como autenticação de bots em Teams ou canais. |
Criar uma Nova Chave de API
- Abrir o formulário de Criação de Chave de API
Na aba Configurações → Chaves de API, selecione o botão Criar Chave de API.
- Selecionar um Tipo de Chave
Escolha entre Chave Privilegiada ou Chave de Visualizador Restrita dependendo do nível de acesso necessário.
- Nomear a chave
Insira um nome descritivo no campo Nome da Chave que identifique claramente o propósito da chave.
- Gerar a chave
Selecione o botão Gerar. A chave será criada e aparecerá na lista de chaves de API.
Copie e armazene sua chave de API de forma segura imediatamente após a geração. O valor completo da chave pode não ser exibido novamente.
Excluir uma Chave de API
A Chave do Automatizador é uma chave do sistema criada automaticamente para cada projeto e não pode ser excluída. Todas as outras chaves de API que você criar podem ser excluídas conforme necessário.
- Na aba Configurações → Chaves de API, selecione o link Excluir para a chave que deseja remover.
- Confirme a exclusão no popup.
Uma mensagem de sucesso confirmará a exclusão e a chave não aparecerá mais na lista.
Melhores Práticas
- Use o tipo de chave correto: Use Chaves Privilegiadas apenas para integrações confiáveis do lado do servidor. Use Chaves de Visualizador Restrita para implantações públicas ou bots de canal.
- Nomes claros: Use nomes descritivos que indiquem claramente o propósito da chave e a integração à qual ela pertence.
- Rotacione regularmente: Exclua e gere novamente as chaves periodicamente para reduzir o risco de acessos não autorizados.