WebAPI de Listagem de Sessões de Usuários

Documentação
,
1

Visão Geral

A WebAPI de Listagem de Sessões de Usuários, como o próprio nome sugere, retorna todas sessões de usuários de um determinado período.

A sessão de usuário é o registro de entrada, atividade e saída de um usuário no sistema. Informações como navegador, logs e tipo de autenticação utilizado também são armazenadas na sessão do usuário.

Web API

A Web API apresentada a seguir segue o padrão RESTful e é hospedada junto com a instância do LATROMI Web.

Endpoint

{latromi_base_url}/api/user-sessions
{latromi_base_url} é um espaço reservado para o endereço base do LATROMI Web, com protocolo + domínio + caminho.

Exemplo: https://demo.latromi.com.br/web

Autenticação

Para consumir a Web API é necessário autenticar o usuário com o uso da Chave de Integração. A chave deve ser passada no cabeçalho da requisição.

Cabeçalho Valor
X-Latromi-IntegrationKey Chave de integração

Autorização

Além de autenticado, o usuário precisa receber permissão para consumir a WebAPI. A permissão é concedida nas configurações da Chave de Integração.

O nome da permissão necessária é Sessões de Usuário (Listagem).

Métodos HTTP

GET

Obtém as sessões de usuários.

Códigos de Retorno

Abaixo os códigos HTTP de status retornados:

Status Descrição
200 Sucesso
400 Erro
401 Não autorizado
Parâmetros

Os parâmetros a seguir podem ser passados na URL (todos opcionais):

Parâmetro Descrição Valor padrão
start Data Inicial Data do dia
end Data Final Data do dia
user Nome de usuário (login)
app Aplicativo
status Estado da sessão

Para o parâmetro app utilize um dos códigos abaixo:

Código Nome
1 Latromi Client
2 Latromi Web

Para o parâmetro status utilize um dos códigos abaixo:

Código Nome Descrição
0 AwaitingActivation Aguardando ativação
1 Active Sessão ativa
2 ClosingRequired Fechando de sessão solicitado pelo administrador
3 Closed Sessão encerrada
Para os parâmetros de data, utilize o formato YYYY-MM-DD ou YYYYMMDD.

Exemplo de requisição:

GET api/user-sessions/?start=20230218&end=20230221&user=admin&app=2

Exemplo de resultado:

[
    {
        "sessionId": 21879,
        "sessionState": "Active",
        "username": "admin",
        "logon": "2023-02-20T19:26:24.717483-03:00",
        "logout": "2023-02-20T20:20:01.717483-03:00",
        "authMethod": "Key",
        "appName": "LATROMI Web",
        "appVersion": "3.5.399.4",
        "ip": "189.6.210.74/32",
        "browser": "Chrome 109.0",
        "lastActivity": "2023-02-20T19:27:18.698348-03:00"
    }
]