Á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 (RO Credentials).

O OAuth2 autoriza o acesso a recursos protegidos e com as aplicações cadastradas, os dados serão utilizados na autenticação e/ou autorização.

      • 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 Modified


03. TELA - OAuth2

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

Client Credentials


Image Modified

Image Modified

Aba RO Credentials

Image Removed

Image Removed

a. Client Credentials

Autorizar aplicativos com OAuth


Principais Campos e Parâmetros

CampoDescrição
Nome do Aplicativo

Informar o nome do aplicativo .Aplicativos conectados recebem tokens em nome de um cliente após a autorização/ integração que será utilizado para a autenticação e geração do token JWT.

Exemplo:

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 ainda mais o tipo de recursos protegidos que o aplicativo conectado pode acessar. Os escopos são atribuídos a um aplicativo conectado ao criá-lo e eles são incluídos nos tokens OAuth durante o fluxo de autorizaçãouma segurança extra ao acesso ao endpoint, no qual efetua a limitação de acesso.

Exemplo:

Nota

Ao finalizar o cadastro é gerado um ID para o aplicativo:

Image Removed

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

Autorizar portais com OAuth

Principais Campos e Parâmetros

CampoDescriçãoIdentificação Portal

Informar o nome do portal.

Exemplo:

Image Removed

Método de Autenticação

Informar o método de autenticação.

Exemplo:

Image Removed

Escopo

Informar o escopo.

Exemplo:

Image Removed

Nota

Ao finalizar o cadastro é gerado um ID para o portal:

Image Removed

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!

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

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>