Plantonizei

Conta e acesso › Autenticação

Entrar

POST/api/v1/auth/loginPública, sem sessão

Como funciona

Abre a sessão de qualquer pessoa da plataforma: gestor de empresa, médico ou equipe interna. Quem entra é decidido pela conta, não pela rota; a resposta diz o papel e a empresa da sessão, e é por ela que o painel e o app escolhem a primeira tela.

A sessão vem no cookie pl_session (HttpOnly). Ela dura 12 horas; com keepSignedIn: true passa para 30 dias. Todo pedido seguinte manda o cookie de volta, nada mais.

  • Conta com segundo fator ligado: o primeiro envio, sem code, volta 401 com mfaRequired: true. A tela pede o código e reenvia o mesmo corpo com code, que aceita o código do aplicativo autenticador (6 dígitos) ou um código de recuperação (XXXX-XXXX).
  • Médico que se cadastrou sozinho e ainda não confirmou o e-mail recebe 403 com code: EMAIL_NAO_CONFIRMADO, e só quando a senha está certa.
  • E-mail inexistente e senha errada dão a mesma resposta, de propósito: a rota não revela quem tem conta.
  • Há teto de tentativas por endereço de origem; passou dele, 429 até a janela virar.
  • legalAcceptancePending: true na resposta manda a pessoa aceitar os termos novos antes de seguir.

Parâmetros

  • codeCorpo · stringCódigo do segundo fator: 6 dígitos do autenticador ou um código de recuperação. Fica vazio na primeira tentativa.
  • emailCorpo · stringE-mail.
  • keepSignedInCorpo · booleanManter conectado: a sessão vale 30 dias em vez de 12 horas.
  • passwordCorpo · stringSenha da conta.

Respostas

200 · Sessão aberta. O corpo descreve quem entrou (o mesmo de GET /me) e o cookie pl_session vem no cabeçalho.

  • adminModulesstring[] · Módulos da plataforma que o papel da equipe interna libera.
  • disabledModulesstring[] · Módulos desligados para a empresa da sessão: o painel esconde o menu e a API recusa as rotas.
  • emailstring · E-mail.
  • impersonatedboolean · A sessão é de suporte: a equipe interna dentro da conta do cliente.
  • internalRolestring · Papel na equipe interna do Plantonizei. Vazio para quem não é da equipe.
  • legalAcceptancePendingboolean · Há Termos ou Política novos que a conta ainda precisa aceitar antes de seguir.
  • namestring · Nome.
  • tenantIdstring · Identificador da empresa cliente.
  • tenantRolestring · Papel na empresa: admin, coordenador, escalista ou hospital. Vazio para médico e equipe interna.
  • userIdstring · Identificador da conta da pessoa.

Corpo de exemplo

{
  "adminModules": [
    "texto"
  ],
  "disabledModules": [
    "texto"
  ],
  "email": "medico@exemplo.com.br",
  "impersonated": true,
  "internalRole": "texto",
  "legalAcceptancePending": true,
  "name": "texto",
  "tenantId": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
  "tenantRole": "texto",
  "userId": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e"
}