NEAD Hub · Documentação

A base de conhecimento para entender os domínios do Hub e evoluir sua API com contexto, contratos e rastreabilidade.

Do domínio ao contrato

Cada módulo segue a mesma jornada: Overview → Histórias do usuário → Casos de uso → Sitemap → API Reference. Comece pelo domínio para compreender o problema; acompanhe as histórias e os fluxos até os contratos de entrada e saída.

Conheça a arquitetura · Consulte os contratos · Saiba como contribuir

Domínios

Identidade e acesso

Autenticação de pessoas, identidade do usuário, tokens de máquina e decisão de acesso a documentos.

Pessoas

Cadastro de pessoas e seus relacionamentos, aniversários e histórico de eventos.

Entrevistas

Entrevistas jurídicas (consultations), assuntos, evolução de status, eventos e dossiê associado.

Processos

Processos jurídicos, números, partes, movimentações, eventos e dossiês.

Atividades

Atividades e prazos, tipos de tarefa, responsáveis, comentários, anexos, eventos e adiamentos.

Agendas

Agendas, listas, itens e ordenação de referências de trabalho.

Documentos e dossiês

Documentos, anexos e referências de dossiê relacionados a pessoas, entrevistas e processos.

Atendimento

Atendimento integrado: contatos, conexões, departamentos, mensagens, notas, templates, outbox e transferência de tickets.

Organização

Núcleos, grupos de trabalho, diretrizes e rótulos de status utilizados na operação.

Workspace

Prévia de prazos e preferências de trabalho, incluindo hábitos e rótulos.

Notificações

Consulta de notificações e atualização de estado de leitura.

Integrações

Consulta de espelhos de processos, movimentações e entrevistas provenientes de integrações.

Operação

Verificações de saúde do backend e das integrações para diagnóstico operacional.

Estado da documentação

Os endpoints são derivados do OpenAPI versionado do backend. Histórias e casos de uso são propostas editoriais iniciais para validação de produto. Rotas foram verificadas no código do front-end; módulos sem página dedicada registram essa ausência. A documentação não comprova disponibilidade em produção.