Entidade: ApiKey

Visão Geral

A entidade ApiKey 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

User: Pertence ao usuário que criou a chave

Company: Vinculada à empresa do usuário

Status Disponíveis

Status	Descrição
`active`	Chave ativa e funcional
`deactivated`	Chave desabilitada temporariamente

Casos de Uso Detalhados

1. Integração com Sistemas Externos

Cenário: Uma empresa precisa integrar seu sistema interno com a plataforma CRM.

Fluxo:

O desenvolvedor acessa o painel de API Keys

Cria uma nova chave com título "Integração Sistema ERP"

Utiliza a chave gerada para autenticar requisições do sistema externo

Benefícios: Autenticação segura sem expor credenciais do usuário principal.

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

Apikey

Entidade: ApiKey#

Visão Geral#

Estrutura da Entidade#

Campos Principais#

Relacionamentos#

Status Disponíveis#

Casos de Uso Detalhados#

1. Integração com Sistemas Externos#

Regras de Negócio#

Criação de Chaves#

Controle de Acesso#

Segurança#

Operações Disponíveis#

Fluxo de Autenticação#

Segurança e Boas Práticas#

Para Desenvolvedores#

Para Usuários#

Limitações e Restrições#