Tokens de API
Guia
O que são Tokens de API?
Seção intitulada “O que são Tokens de API?”Tokens de API são credenciais de autenticação que permitem que sistemas externos acessem os recursos do workspace via API. Cada token é vinculado a um workspace específico e pode ser configurado com prazo de validade.
Acessando o Gerenciamento de Tokens
Seção intitulada “Acessando o Gerenciamento de Tokens”Para gerenciar os tokens de API de um workspace:
- Acesse a página de configuração do workspace (botão de engrenagem na navbar)
- Clique na aba Tokens de API
Criando um Token
Seção intitulada “Criando um Token”Para criar um novo token de API:
- Clique em Criar Token
- Preencha os campos:
| Campo | Obrigatório | Descrição |
|---|---|---|
| Nome do token | Sim | Identificador personalizado para o token |
| Expiração | Não | Data e hora de expiração (opcional) |
- Clique em Criar
- O token completo será exibido no diálogo
Visualizando Tokens
Seção intitulada “Visualizando Tokens”Cada token é exibido como um card com as seguintes informações:
| Informação | Descrição |
|---|---|
| Nome | Identificador do token |
| Prefixo | Primeiros 8 caracteres do token (ex: prod_abc...) |
| Criado em | Data e hora de criação |
| Expiração | Data e hora de expiração, ou “Nunca” se não definido |
| Uso | Número de chamadas de API realizadas com o token |
| Status | Ativo ou Inativo |
Ações Disponíveis
Seção intitulada “Ações Disponíveis”Cada token possui as seguintes ações:
| Ação | Descrição |
|---|---|
| Copiar | Copia o prefixo do token para a área de transferência |
| Regenerar | Gera um novo token, invalidando o anterior |
| Ativar/Desativar | Alterna o status do token entre ativo e inativo |
| Revogar | Desativa permanentemente o token |
Status do Token
Seção intitulada “Status do Token”| Status | Descrição |
|---|---|
| Ativo | Token funcional, pode ser utilizado para chamadas de API |
| Inativo | Token desativado, não aceita chamadas de API |
| Expirado | Token passou da data de expiração (automaticamente inativo) |
| Revogado | Token foi revogado explicitamente pelo usuário |
APIs Disponíveis
Seção intitulada “APIs Disponíveis”Com um token de API válido, você pode acessar os seguintes recursos:
| Recurso | Endpoint | Operações |
|---|---|---|
| Agentes | /api/agent-base | Listar, instalar, atualizar, excluir |
| Execuções de Agentes | /api/agent-base/{id}/executions | Listar |
| Webhooks | /api/webhook/* | Enviar eventos |
| Integrações | /api/integrations-base | Listar, criar, atualizar, excluir |
| Base de Conhecimento | /api/knowledge-base | Listar, buscar |
| Triggers | /api/agent-base/triggers | Listar, executar, detalhes |
| Assistant Chat | /api/assistant/chat | Chat (SSE), histórico |
| Storage | /api/knowledge-base/storage | Upload, download, excluir, listar |
Boas Práticas de Segurança
Seção intitulada “Boas Práticas de Segurança”- Nunca compartilhe tokens em repositórios públicos ou códigos-fonte
- Utilize nomes descritivos para identificar facilmente o proposito de cada token
- Configure prazos de validade sempre que possível
- Revogue tokens que não estão mais em uso
- Utilize um token por aplicação para facilitar o rastreamento e revogação