Visão Geral#
A entidade Chave de API representa chaves de API personalizadas que permitem aos usuários autenticar e acessar recursos do sistema de forma programática. Cada chave é única, vinculada a um usuário específico e sua empresa, oferecendo controle granular sobre o acesso aos dados e funcionalidades da aplicação.Estrutura da Entidade#
Campos Principais#
| Campo | Tipo | Descrição | Obrigatório |
|---|
id | number | Identificador único da chave API | ✅ (auto) |
value | string | Valor único da chave API gerada | ✅ (auto) |
title | string | Nome descritivo para identificar a chave | ✅ |
companyId | number | ID da empresa proprietária | ✅ (auto) |
userId | number | ID do usuário criador | ✅ (auto) |
status | enum | Status da chave (active ou deactivated) | ✅ |
createdAt | DateTime | Data/hora de criação | ✅ (auto) |
updatedAt | DateTime | Data/hora da última atualização | ✅ (auto) |
Relacionamentos#
Usuário: Pertence ao usuário que criou a chave
Empresa: Vinculada à empresa do usuário
Status Disponíveis#
| Status | Descrição |
|---|
active | Chave ativa e funcional |
deactivated | Chave desabilitada temporariamente |
Casos de Uso Detalhados#
Cenário: Uma empresa precisa integrar seu sistema interno com a plataforma CRM.O desenvolvedor acessa o painel de Chave de API
Cria uma nova chave com título "Integração Sistema ERP"
Utiliza a chave gerada para autenticar requisições do sistema externo
Regras de Negócio#
Criação de Chaves#
Cada chave é única no sistema
Valor gerado automaticamente baseado no ID do usuário e título
Status inicial sempre definido como 'active'
Vinculação automática ao usuário autenticado e sua empresa
Controle de Acesso#
Usuários só podem gerenciar suas próprias chaves
Isolamento por empresa (multi-tenancy)
Não há limite definido de chaves por usuário
Chaves desativadas não permitem autenticação
Segurança#
Valores das chaves não são editáveis diretamente
Regeneração automática ao alterar o título
Exclusão permanente ao deletar a chave
Validação de integridade em todas as operações
Operações Disponíveis#
| Operação | Descrição | Método HTTP |
|---|
| Listar | Recupera todas as chaves do usuário com paginação | GET |
| Criar | Gera nova chave API personalizada | POST |
| Visualizar | Exibe detalhes de uma chave específica | GET |
| Atualizar | Modifica título ou status da chave | PUT/PATCH |
Fluxo de Autenticação#
Segurança e Boas Práticas#
Para Desenvolvedores#
Nunca expor chaves em código versionado
Usar variáveis de ambiente para armazenar chaves
Para Usuários#
Usar títulos descritivos para identificar contexto
Desativar chaves não utilizadas
Excluir chaves de projetos descontinuados
Não compartilhar chaves desnecessariamente
Limitações e Restrições#
Chaves são específicas por usuário e empresa
Modificado em 2025-06-16 14:36:23
