Profile Server API
Manual do usuário

Introdução ao painel

O que é o painel administrativo, como entrar, navegar e ajustar o tema.

Este manual explica como usar o painel administrativo do Profile Server, tela por tela — o que cada página faz, quais campos preencher e o que acontece em cada ação. Ele é voltado a quem opera o sistema; para o contrato técnico das rotas, veja a seção Endpoints ou o Swagger.

Acessando o painel

  1. Abra o endereço do painel no navegador. Você será direcionado para a tela de login (Keycloak).
  2. Entre com seu e-mail e senha. Se a sua conta acabou de ser criada, você recebeu um e-mail com um link para definir a senha — faça isso antes do primeiro acesso.
  3. Após o login você volta ao painel automaticamente.

Sessão expirada

Se a sessão expirar, o painel volta sozinho para a tela de login. Basta entrar novamente — nenhum dado já salvo é perdido.

A barra lateral esquerda (no celular, o menu ☰ no topo) lista as áreas do sistema:

ItemO que gerencia
ClientesAs empresas clientes da plataforma
AplicaçõesOs apps que rodam sobre a plataforma
TenantsAs instâncias de um app para um cliente
UsuáriosAs pessoas que acessam o sistema
OrganizaçõesCooperativas e organizações operacionais
Tipos de DocumentoAs regras de cada documento exigido
DocumentosOs documentos enviados e sua revisão

No topo da barra lateral fica a identificação da conta que você está representando — o nome dela, com Gestão de Documentos logo abaixo. Se você estiver representando Todos os tenants (ver Representando), aparece Reciclar no lugar do nome. Nomes longos são cortados: passe o mouse para ver o texto completo.

No rodapé da barra lateral fica o menu do usuário, com seu nome, e-mail e o botão Sair.

Representando

Se você participa de mais de uma organização/conta no sistema, aparece no topo da barra lateral — logo abaixo do logo — um seletor chamado Representando. Ele define em nome de quem você está atuando no momento, e isso também define seu perfil de acesso: você pode ter um perfil diferente em cada uma (ex.: administrador em uma, técnico em outra).

OpçãoQuem vêO que você vê
Todos os tenantsSó administrador da plataformaTudo, de todas as contas, somado
Uma opção específicaTodo mundoSó o que pertence àquela conta — e com o perfil de acesso que você tem nela

Fora do administrador da plataforma, é sempre necessário estar representando algo específico — não existe modo "ver tudo" para quem não é administrador da plataforma.

Ao trocar, as telas abertas são recarregadas com o novo escopo: uma listagem pode encolher e um registro que estava visível pode deixar de estar. Se você tiver um formulário preenchido e não salvo no momento da troca, salve antes — a tela é atualizada por baixo.

Só aparece com duas ou mais opções

Quem só tem uma opção não vê o seletor: não haveria escolha a fazer, e o painel já opera automaticamente nela.

A escolha fica salva neste navegador — em outro computador ou celular você começa de novo (na primeira opção da lista, ou em "Todos os tenants" se você for administrador da plataforma). Se a opção selecionada deixar de estar disponível (ex.: seu vínculo foi removido), o painel avisa e volta sozinho para uma seleção válida.

Sem acesso configurado numa das opções?

Se você foi vinculado a uma conta mas ainda não recebeu um perfil de acesso nela, essa opção aparece no seletor com o aviso Sem acesso. Você ainda pode selecioná-la, mas as telas daquela conta vão mostrar erro de permissão ao serem abertas. Procure quem administra o sistema para configurar seu perfil ali.

Tema claro e escuro

No canto superior direito há o botão de tema, com três opções: Claro, Escuro e Sistema (segue a preferência do seu dispositivo). A escolha fica salva no navegador.

Permissões

O que cada pessoa vê e pode fazer no painel depende do seu perfil de acesso. O menu lateral mostra só as áreas liberadas para o seu perfil — se você não usa Clientes, Aplicações, Tenants ou Usuários, por exemplo, é porque seu perfil não tem acesso a essas áreas, não porque algo quebrou.

PerfilO que vê e faz
Administrador da plataformaAcesso completo a tudo, incluindo Clientes, Aplicações, Tenants e Usuários.
Administrador do tenantAcesso completo às áreas operacionais (Organizações, Documentos, Tipos de Documento), mas não vê Clientes, Aplicações, Tenants nem Usuários — essas são exclusivas do administrador da plataforma.
TécnicoCadastra e edita Organizações e Documentos; só consulta Tipos de Documento (não cria nem edita).
VisualizadorSó consulta Organizações, Documentos e Tipos de Documento — sem cadastrar, editar ou excluir nada.

Dentro de uma tela liberada, as ações também variam: um botão pode aparecer desabilitado, com uma explicação ao passar o mouse, quando seu perfil não tem permissão para aquela ação específica (por exemplo, excluir mas não editar). Isso é esperado — procure quem administra o sistema se precisar de mais acesso.

Convenções deste manual

  • Campos obrigatórios aparecem nas tabelas com "Sim" na coluna Obrigatório.
  • Toda exclusão pede confirmação antes de executar — nada é excluído com um clique só.
  • Após salvar, uma notificação no canto da tela confirma o sucesso (ou explica o erro).