Árvore de páginas

Versões comparadas

Chave

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

As suítes de serviços dos produtos financial services TOTVS utilizam para autenticação o protocolo Oauth 2.0. Possuir uma aplicação cliente configurada bem como o tipo de autenticação que será utilizada são pré requisitos para a utilização. Esta configuração prévia é pré-requisito para utilização desta documentação, caso ainda não realizada, clique aqui para ver a documentação de como proceder.

 

O processo de autenticação consiste em um requisição rest para o servidor de autenticação passando parâmetros pré-definidos conforme descrito abaixo. O endereço da aplicação para autenticação sempre seguirá o padrão http://SERVIDOR:PORTA/suite_serviço_utizada/oauth/token, onde SERVIDOR deve ser substituído pelo endereço do servidor JBoss, PORTA pelo número da porta do servidor JBoss e suite_serviço_utizada pelo nome da aplicação contendo os serviços que serão consumidos. Abaixo exemplo de uma URL:

...

Para cada grant type selecionado os parâmetros enviados, assim como o retorno, podem sofrer modificações, o quadro abaixo detalha cada um deles.

Deck of Cards
startHiddenfalse
idAutenticações permitidas
Card
labelAutenticação para Usuário

Retorna tokens de acesso e refresh para um usuário e senha informados. Usuário e senha necessitam estar, previamente, cadastrados no sistema de segurança TOTVS.

Para obter o token de acesso utilizando este tipo de autenticação, utilizar os parâmetros e valores abaixo:

grant_type=password

username=USUÁRIO

password=SENHA

A figura acima apresenta a requisição e a resposta de um pedido de autorização utilizando o grant_type password.

Card
labelAutenticação para cliente

Para obter autenticação para uma aplicação cliente informar o tipo de grant client_credentials, conforme exemplificado abaixo. Este tipo de tipo de autenticação retorna apenas o token de acesso.

grant_type=client_credentials

A figura acima apresenta a requisição e a resposta de um pedido de autorização utilizando o grant_type client_credentials.

Card
labelAtualização TolkenToken

Para renovar a autorização e obter um novo token de acesso, a partir de um token de atualização (refresh token). Abaixo detalhes de utilização.

grant_type=refresh_token

refresh_token= REFRESH TOKEN retornado em uma requisição anterior do tipo PASSWORD ou REFRESH_TOKEN.

]

A figura acima apresenta a requisição e a resposta de um pedido de autorização utilizando o refresh_token.

...