API Sessões

Chamadas de API para operação de sessões de Usuários.

Base path: /sessions/

Esta API pode ser utilizada para o controle de sessões de usuários. Você poderá listar as sessões ativas, desconectar usuários e/ou enviar mensagens que serão apresentadas para os usuários.

---

Listar Sessões

Realiza a consulta das sessões que estão ativas na plataforma Autosky.

GET /sessions/

Parâmetros de Query (opcionais)

Parâmetro	Tipo	Descrição
cli_uuid	string	UUID do cliente para filtro

Resposta

Status: 200 OK

[
    {
        "ssid": "9cfb4863",
        "client": {},
        "user": {},
        "instance": {},
        "creation_date": "2017-10-02T18:35:14.470434Z",
        "termination_date": null,
        "termination_reason": "",
        "status": "ativa",
        "my_ip": "99.99.99.99"
    }
]

Campos do Objeto Sessão

Campo	Tipo	Descrição
ssid	string	Identificador único da sessão
client	object	Dados do cliente associado
user	object	Dados do usuário associado
instance	object	Dados da instância
creation_date	string	Data/hora de criação da sessão (ISO 8601)
termination_date	string/null	Data/hora de encerramento da sessão
termination_reason	string	Motivo do encerramento
status	string	Status da sessão (ex: ativa)
my_ip	string	IP do usuário

---

Obter dados de uma sessão

Obtém dados de uma sessão especificada por seu identificador.

GET /sessions/{ssid}

Parâmetros de Path

Parâmetro	Obrigatório	Descrição
ssid	Sim	ID único da sessão

Resposta

Status: 200 OK

Retorna o objeto da sessão com a mesma estrutura da listagem.

---

Remover Sessão

Procedimento de remoção/desconexão de um usuário.

Quando utilizado, envia uma mensagem de desconexão ao usuário com um timer de desligamento. Caso o usuário não feche a sessão espontaneamente, a sessão é encerrada dentro do timer definido (em minutos).

DELETE /sessions/{ssid}

Parâmetros de Path

Parâmetro	Obrigatório	Descrição
ssid	Sim	ID único da sessão

Body da Requisição

Campo	Tipo	Obrigatório	Descrição
time	number	Sim	Tempo em minutos para encerramento da sessão
message	string	Não	Mensagem de aviso de desconexão

Exemplo de Requisição

{
    "time": 10,
    "message": "Manutenção preventiva em 10 minutos"
}

Resposta

Status: 200 OK

{
    "status": "success"
}