Skip to content

Presença de Usuário

Este endpoint gerencia e exibe o status online dos usuários dentro de um período contábil específico, permitindo saber quem está trabalhando no mesmo contexto em tempo real.

Objeto Usuário Online

AtributoTipoDescrição
user_idstringO ID do usuário que está online.
usernamestringO nome de usuário.
avatar_urlstringA URL para o avatar do usuário.

Listar Usuários Online

Retorna uma lista de usuários que estão atualmente ativos em um período contábil específico.

GET/api/user-presence

Parâmetros de Query

ParâmetroTipoDescrição
organizationIdstringObrigatório. O ID da organização.
activeAccountingPeriodIdstringObrigatório. O ID do período contábil.

Resposta

Retorna um array de objetos de Usuário Online.

Códigos de Status HTTP

  • 200 OK: Usuários online listados com sucesso.
  • 400 Bad Request: Parâmetros de query ausentes ou inválidos.
  • 401 Unauthorized: Autenticação necessária ou credenciais inválidas.
  • 500 Internal Server Error: Erro interno do servidor ao listar a presença de usuários.

Atualizar Presença

Atualiza o status de presença do usuário, informando ao sistema que ele está ativo em um determinado período contábil. Este endpoint deve ser chamado periodicamente pelo frontend enquanto o usuário estiver ativo.

POST/api/user-presence

Corpo da Requisição

json
{
  "organizationId": "o1p2q3r4-s5t6-7890-1234-567890abcdef",
  "activeAccountingPeriodId": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}

Resposta

200 OK com uma mensagem de sucesso.

Códigos de Status HTTP

  • 200 OK: Presença atualizada com sucesso.
  • 400 Bad Request: Corpo da requisição inválido.
  • 401 Unauthorized: Autenticação necessária ou credenciais inválidas.
  • 500 Internal Server Error: Erro interno do servidor ao atualizar a presença.