Histórico da Página

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:

http://192.168.10.10:8080/tfs-credito-service/oauth/token

Os parâmetros abaixo devem ser informados em todos os tipos de requisição de autenticação

• client_secret - sempre informar secret
• grant_type - Informar um dos tipos de permissão suportados, clique aqui para verificar os tipos suportados
• client_id - nome do usuário da aplicação cliente previamente cadastrado conforme documentação.

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

Para os exemplos de requisição acima foi utilizado o plugin DHC do navegador Chrome.

O token de acesso, retornado de uma das requisições descritas acima, deve ser informado no HEADER, através do parâmetro Authorization, ao consumir os serviços da suite de crédito seguindo os procedimentos descritos abaixo.

Nome do Parâmetro - Authorization

Valor - informar o tipo do token, também retornado na resposta a requisição, mais o valor do token de acesso separados por espaço. Exemplo: 

Depois de receber o token

Para cada requisição, devemos passar um parâmetro no HEADER:

Nome do parâmetro: Authorization

Valor:  [{token_type} {refre}]

Exemplo (conforme imagem acima):

Authorization=[bearer cf7e583d-0ed7-4ade-a88d-e6aac3dd54ff]e6aac3dd54f

A imagem abaixo destaca a utilização do parâmetro na ferramenta SoapUI, ferramenta está utilizada para consumo de web services em ambientes de desenvolvimento e teste.

Image Added