Árvore de páginas

Versões comparadas

Chave

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

CONTEÚDO

Informações
iconfalse
Índice
maxLevel3
minLevel2
indent50px
absoluteUrltrue

01. VISÃO GERAL

O objetivo desta tela é efetuar o cadastro dos parâmetros a serem utilizados no serviço de login com OAuth2 no qual propões duas etapas para o acesso a um determinado endpoint, a autenticação e autorização.

      • A
parametrização é conforme o tipo a ser utilizado: Client Credentials ou Resource Owner Credentials.

Com as aplicações cadastradas, os dados serão utilizados na autenticação/autorização.

Também ocorre o cadastro do escopo de acesso (scope) para a restrição na requisição, quando for solicitado ao Resource Server.

      • autenticação é a validação do usuário / senha, caso o mesmo seja válido, um token JWT é retornado para uso posterior. 
      • Com o token JWT, o mesmo deve ser enviado a cada requisição para que seja autorizado o acesso aos endpoints.
Dica
titleDica

O modelo Client Credentials é utilizado em integrações que possuem acesso direto aos endpoints, no qual consideram as conexões entre máquinas, ou seja, o M2M (Machine to Machine) Comunications.

Exemplo; AppServer, Mingle, Apps, entre outros

Já o modelo Resource Owner Password Credentials é utilizado em integrações que possuem que fazem uso de navegador, com a autenticação conforme o produto TOTVS - Linha Datasul.

Exemplo: Portais

02. EXEMPLO DE UTILIZAÇÃO

Para acessar a área de Propriedades OAuth2, basta acessar a tela de Propriedades do produto pelo menu (digitando: propriedades) ou pela engrenagem na barra superior - - em seguida pesquisar no campo de busca por OAuth2 ou procurar na tela o Card Propriedades OAuth2:Image Removed

Image Added


03. TELA - OAuth2

A seguir é apresentada a tela de parâmetros do modelo OAuth2:Aba

Client Credentials

Image Removed

Aba RO Credentials

Image Removed

a. Client Credentials

Image Added

Image Added


Principais Campos e Parâmetros

CampoDescrição
Nome do Aplicativo

Informar o nome do aplicativo

.
EscopoInformar o escopo.

Card documentos
InformacaoEsse modo de acesso será utilizado somente pelas conexões entre máquinas, ou seja, o M2M (Machine to Machine) Comunications. Ex: mingle, appserver, rpw e outros.
TituloIMPORTANTE!

b. RO Credentials

Principais Campos e Parâmetros

CampoDescriçãoIdentificação PortalInformar o nome do portal.Método de Autenticação

Informar o método de autenticação.

Exemplo:

Image Removed

EscopoInformar o escopo.

Card documentos
InformacaoEsse modo de acesso será utilizado pelas aplicações que fazem uso de navegador e são reconhecidas pela TOTVS. Ex: portais, integrações e outros.
TituloIMPORTANTE!

Principais Campos e Parâmetros

CampoDescrição

Usuário

Login de usuário do produto que será adotado para acesso ao produto por meio do link gerado pelo RFI.

Esta chave é obrigatória, pois o acesso ao produto via Token somente irá liberar o acesso ao produto, mas não indicará o usuário Datasul para acessar a funcionalidade da regra de negócio que será executada pelo link gerado pelo RFI.

Card documentos
InformacaoÉ preciso configurar um usuário especifico para o RFI, com permissão somente aos programas que o mesmo for utilizar, não é recomendado este possuir permissão a muitos programas com nível de acesso elevado, por questões de segurança.<br/> Para descobrir quais os programas são necessários para o funcionamento do RFI com a funcionalidade que deseja, é preciso retirar a permissão aos programas, e apenas habilitar os que, após a execução da funcionalidade desejada, notifiquem a falta de permissão. <br/><br/> Por exemplo, a funcionalidade de <b>esqueci minha senha</b>, ao desabilitar todos e executar o mesmo, irá notificar a falta de permissão ao programa <b>html.rfimodules.fnd</b>, logo será necessário ativar a permissão do usuário a este programa, e a funcionalidade estará pronta para execução.
TituloIMPORTANTE!
URL

Login de usuário do produto que será adotado para acesso ao produto por meio do link gerado pelo RFI.

Esta chave é obrigatória, pois o acesso ao produto via Token somente irá liberar o acesso ao produto, mas não indicará o usuário Datasul para acessar a funcionalidade da regra de negócio que será executada pelo link gerado pelo RFI.

URL

URL base para acessos ao sistema via RFI

O endereço URL deverá ser informado no seguinte formato: [Protocolo]+ [URL]

Exemplo: 

    http://www.meusite.com.br/localrfi

Esta chave é obrigatória e o seu conteúdo é utilizado para construção de links de acesso ao sistema via uma chave de acesso (Token).

A URL gerada para acesso ao sistema é composta com a seguinte estrutura:

        <protocolo>://<servidor>:<porta>/datasul-rfi/auth/?guid=<token>

Exemplo:  http://meu_servidor:8480/datasul-rfi/auth/?guid=8d494e92-10ff-bcb3-1314-07fc6c8a8b76

Card documentos
InformacaoAtente para que o endereço URL base informado atenda acessos ao sistema tanto a partir de rede interna, quanto a partir de um acesso externo, pois a geração do link de acesso via RFI somente irá utilizar a URL informada e agregar o valor do token de acesso gerado ao final da URL.
TituloIMPORTANTE!

Aviso
iconfalse
titleAtenção!
Informações
iconfalse
É recomendado como boa prática na configuração do produto, que a URL configurada para acesso via RFI seja uma URL de acesso externo, para não expor o HOST/PORT de acesso interno ao sistema. 
Mesmo sendo uma URL de acesso externo, não pode redirecionar internamente para o mesmo webserver utilizado pelo acesso interno.

Dessa forma o indicado é configurar 2 webserver (tomcat), sendo um deles de uso exclusivo para acessos externos como no caso de acessos via RFI e integrações EAI. Para isso deve-se configurar um HOST e PORT de uso para os links de acesso externo diferente do HOST e PORT do acesso interno ao produto e, ambos acessos (interno e externo) deverão ter suas requisições processadas por WEBServers distintos (tomcat).

Card documentos
InformacaoCaso seja gerado diversos links do RFI com empresas diferentes, deve-se efetuar o logout da tela antes de acessar o próximo link, caso contrário a empresa não será alterada.
TituloIMPORTANTE!

/ integração que será utilizado para a autenticação e geração do token JWT.

Exemplo:

Image Added

Informações
titleInformação

As chaves para a autenticação são geradas automaticamente após o cadastro.

Escopo

Informar o escopo.

O escopo define uma segurança extra ao acesso ao endpoint, no qual efetua a limitação de acesso.

Exemplo:

Image Added

Informações
titleInformação

O campo Escopo pode ser preenchido com o valor do módulo a ser restrito segundo a estrutura definida no Guia de implementação de API.

"{protocolo}://{host}/{api}/{modulo}/{versao}/{recurso}"

Para o exemplo acima, é permitido o acesso somente aos endpoints que possuem o módulo /btb, para outros módulos, ocorrerá o retorno HTTP status 403 (Forbidden).


Caso seja necessário configurar mais de um módulo, os mesmos podem ser cadastrados separados por espaço.

Image Added


Caso não seja necessário restringir o acesso, pode ser utilizado o valor * (asterisco)

Nota

Ao finalizar o cadastro, basta clicar em "Exibir detalhes completamente" para apresentar chaves para autenticação (Id cliente, Senha cliente).

Image Added

Nota
titleNota

O modelo Resource Owner Password Credentials (ROPC) não necessita ser cadastrado pois utiliza as credenciais do ERP Datasul.

Para mais informações quanto a sua utilização, consulte o link: https://tdn.totvs.com/pages/releaseview.action?pageId=696121515

04. ASSUNTOS RELACIONADOS

Principais Campos e Parâmetros

CampoDescriçãoEndereço IP ou nome do servidor de aplicação WEB *

Informar o servidor que se encontra a instância do Servidor de aplicação.

Porta do servidor de aplicação Web

Neste campo deve-se informar a porta utilizado pelo Servidor de aplicação.

Endereço IP ou nome do servidor de aplicação WEB (Externo) *

Informar o servidor que se encontra a instância do servidor de aplicação para requisições externas .

Porta do servidor de aplicação Web (Externo)

Neste campo deve-se informar a porta utilizada pelo servidor de aplicação para requisições externas .

Aviso
titleAtenção

A partir dos patches:

  • 12.1.34.4
  • 12.1.33.9
  • 12.1.32.15
  • E da release 12.1.2205

O Endereço IP ou nome do servidor de aplicação WEB e o Endereço IP ou nome do servidor de aplicação WEB (Externo) poderão ser informados usando o protocolo seguro caso este seja utilizado.

Ex: Ao invés de somente servidor deverá ser informado HTTPS://servidor quando utiliza protocolo seguro, como ilustrado na imagem abaixo:

Image Removed

O uso do HTTP (que indica que não se usa protocolo seguro) é facultativo.

HTML<!-- esconder o menu --> <style> div.theme-default .ia-splitter #main { margin-left: 0px; } .ia-fixed-sidebar, .ia-splitter-left { display: none; } #main { padding-left: 10px; padding-right: 10px; overflow-x: hidden; } .aui-header-primary .aui-nav, .aui-page-panel { margin-left: 0px !important; } .aui-header-primary .aui-nav { margin-left: 0px !important; } </style>