Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Os dados solicitados pelo endpoint devem ser enviados seguindo o modo Client Credentials Password Grant do protocolo OAuth2 e serão recepcionados pela API para a efetivação da ação de login. Uma vez validados os parâmetros, a API responderá com um token válido para a sessão, onde seus aspectos principais estarão definidos. Permissões e demais critérios de sessão estarão disponíveis através do token Bearer fornecido, e sua validade padrão será 20 (vinte) minutos. Uma vez expirado, o token perderá sua validade, o que impossibilitará a troca de mensagens entre as APIs TOTVS Recintos Aduaneiros e seus clientes.

Para a renovação da sessão, o cliente deverá acessar o endpoint específico para talde autenticação, fornecendo o refresh token obtido no início da sessão. É importante lembrar que, para este fim, o refresh token só pode ser utilizado uma única vez de forma a garantir o correto estabelecimento de sessões de usuário. O uso de um refresh token em um processo de renovação de sessão gerará um novo par de tokens - sessão e renovação -, os quais são validados em conjunto para a ação de renovação. O token de renovação tem um tempo de vida de cinco minutos, contatos a partir da expiração do token de sessão e não pode ser utilizado antes da expiração ocorrer.

Para o estabelecimento de sessões, onde o servidor OAuth2 esteja implementado - utilizando-se, por exemplo, o protocolo HTTP para rede local ou HTTPS para implantação em ambientes externos, e tendo os endereços http://[servidor] :3210 ou https://[servidor] :3210 como a diretiva [servidor] -, deve-se seguir as seguintes instruções:

    1. Utilizar o endpoint [servidor]/api/sara/authentication/v1/auth/login para efetuar a ação de login e iniciar uma sessão de usuáriosession/token para obter um token JWT válido para transações com os serviços do ecossistema Recintos Aduaneiros;
    2. Utilizar o endpoint [servidor]/api/sara/v1/auth/logout para encerrar uma sessão de usuário ativa no servidor e;Utilizar o endpoint [servidor]/api/saraauthentication/v1/authsession/refresh para token para restaurar uma sessão de usuário utilizando o respectivo refresh token.

Não haverá disponibilidade de sessões simultâneas para um mesmo usuários dentro de um mesmo contexto escopo - sendo os contextos escopos disponíveis desktop, mobile e web. Sendo assim, o início de uma nova sessão dentro de um contexto escopo em que o usuário possua uma sessão aberta, anulará a sessão anterior. Isso impedirá o usuário de ter múltiplas sessões simultâneas que não estejam em contextos escopos diferentes - uma sessão desktop e outra mobile, por exemplo -, permitindo um controle mais preciso do uso de licenças junto à TOTVS.

...