Para utilização desta rotina, é pré-requisito o cadastramento dos seus respectivo Documento, Transação e Funções. O quadro abaixo detalha como realizar estes cadastros.
Após validar e/ou cadastrar as configurações acima, o sistema está apto para seguir com as configurações da autenticação Oauth seguindo os passos abaixo.
Selecionar módulo segurança conforme imagem abaixo.
Acessar item de menu referente à transação de Configuração da autenticação Oauth, autenticação esta utilizada pelas suítes de serviços, conforme exibido na figura abaixo.
A transação de manutenção de configuração da autenticação Oauth possui 4 funções, são elas:
- Incluir;
- Alterar;
- Visualizar;
- Excluir.
Abaixo detalhes de como utilizar cada uma das 4 funcionalidades da transação.
Preenchimento dos campos:
- Identificação do Usuário - Nome que será utilizado pela aplicação cliente para requisição de autenticação;
- Validade Token Acesso - Tempo, em segundos, de validade do token de acesso;
- Validade Refresh Token - Tempo, em segundos, de validade do refresh token (token de atualizaçã);
- Tipo de permissão - Mais de um tipo de permissão pode ser selecionado ao mesmo tempo, lembrando que o tipo REFRESH_TOKEN trabalha em conjunto com PASSWORD. Abaixo os tipos de autenticação suportados pelas aplicações TOTVS, assim como uma breve explicação para cada um deles. Maiores informações podem ser obtidas no site oficial dos desenvolvedores Oauth clicando aqui.
- CLIENT_CREDENTIALS - Utilizado para requisitar acesso para uma aplicação, nesta opção, não é retornado um token de atualização, logo, após expirar o token retornado, outra requisição deve ser feita;
- PASSWORD - Utilizado para requisitar acesso para um determinado usuário, usuário este deve estar previamente cadastrado no sistema de segurança. Ao realizar este tipo de requisição, além do token de acesso, é retornado um token de atualização (Refresh Token).
- REFRESH_TOKEN - Utilizado para renovar um acesso utilizando um token de atualização retornado em uma requisição anterior. Este tipo de requisição retornará novos tokens de acesso e atualização.
