oAuth
O protocolo elimina a necessidade de confiar no aplicativo um nome de usuário e senha e também permite que você emita um conjunto limitado de direitos, e não todos de uma vez.
Para autenticação, o parâmetro Redirect URI é dinâmico. A própria Albato transferirá o valor necessário para o sistema, ele só precisa ser especificado nas URLs e na solicitação.
Além disso, certifique-se de passar o parâmetro GET State na URL de autenticação. Esta é uma condição necessária, pois é por meio dela que a Albato entende a qual usuário e conexão a sessão se referirá. Se o serviço não funcionar com este parâmetro, a configuração é impossível.
Ao escolher o método de autenticação oAuth, o caminho de configuração difere de todos os outros métodos, vamos analisá-lo em mais detalhes.
A primeira coisa a configurar ao criar tal autenticação é:
URL da autenticação - na janela que se abre é necessário cadastrar a URL para a qual o usuário deve enviar a autenticação no sistema em que a automação está conectada. O URL deve ser inserido por completo, com todos os parâmetros GET necessários. Os parâmetros GET são escritos manualmente e podem conter dados estáticos ou variáveis dinâmicas (ao clicar no campo, aparece uma lista, as variáveis estão na guia “Parâmetros de autenticação”), como Estado, ID do cliente, Redirecionar URI.
Client ID - é cadastrado o “Client ID” do aplicativo criado no sistema. Este parâmetro é lembrado como parte da autenticação criada.
Client Secret - é cadastrado o “Segredo do Cliente” do aplicativo criado no sistema. Este parâmetro é lembrado como parte da autenticação criada.
Exemplo de configuração:
Em seguida, você precisa configurar as solicitações HTTP para receber o token de acesso e, se necessário, o token de atualização.
Caso o token precise ser atualizado, você precisa marcar a caixa Usar RefreshToken:
Esta caixa de seleção permite, na guia de resposta do primeiro widget de solicitação (que recebe o token de acesso), salvar o token de atualização recebido na resposta a uma variável:
Além disso, ao criar um widget de solicitação de atualização de token, essa variável estará disponível na guia Solicitação e o valor da variável (que salvamos anteriormente) será passado na solicitação de atualização de token.
*
Adicione um widget de solicitação para receber um token de acesso e configure-o conforme necessário para o sistema.
As seguintes variáveis dinâmicas estão disponíveis para a consulta:
Client ID - parâmetro que foi salvo como parte da autenticação.
Client Secret - parâmetro que foi salvo como parte da autenticação.
Redirect URI - URL de redirecionamento gerado, que está vinculado à autenticação criada.
Code - o código recebido na resposta, ao autorizar e conceder acesso.
Na guia de resposta, é necessário configurar o analisador de resposta para receber o token de acesso, atualizá-lo e salvá-lo nos campos criados anteriormente.
Se você precisar atualizar o token, adicione o mesmo widget de solicitação, na seção "Atualizar token". Nesta solicitação, você pode passar as mesmas variáveis dinâmicas, mas, além delas, também deverá informar o token de acesso obtido anteriormente e o token de atualização.
Ao criar uma conexão com a aplicação, tal autenticação permite fornecer ao usuário final a URL pela qual ele concederá o acesso ao sistema. Então, a Albato retornará seu código temporário, que é trocado por um token de acesso.
Em seguida:
A solicitação de obtenção é feita assim que o usuário concede acesso, recebe os tokens necessários e os salva dentro da conexão.
Uma solicitação de atualização é feita no momento em que qualquer uma das entidades do aplicativo faz uma solicitação HTTP de saída e o aplicativo (serviço) retorna um erro indicando que o token expirou (deve haver um tratamento de erro com o tipo apropriado para o widget).
Para autenticação, o parâmetro Redirect URI é dinâmico. A própria Albato transferirá o valor necessário para o sistema, ele só precisa ser especificado nas URLs e na solicitação.
Além disso, certifique-se de passar o parâmetro GET State na URL de autenticação. Esta é uma condição necessária, pois é por meio dela que a Albato entende a qual usuário e conexão a sessão se referirá. Se o serviço não funcionar com este parâmetro, a configuração é impossível.
Configuração da autenticação
Ao escolher o método de autenticação oAuth, o caminho de configuração difere de todos os outros métodos, vamos analisá-lo em mais detalhes.
A primeira coisa a configurar ao criar tal autenticação é:
URL da autenticação - na janela que se abre é necessário cadastrar a URL para a qual o usuário deve enviar a autenticação no sistema em que a automação está conectada. O URL deve ser inserido por completo, com todos os parâmetros GET necessários. Os parâmetros GET são escritos manualmente e podem conter dados estáticos ou variáveis dinâmicas (ao clicar no campo, aparece uma lista, as variáveis estão na guia “Parâmetros de autenticação”), como Estado, ID do cliente, Redirecionar URI.
Client ID - é cadastrado o “Client ID” do aplicativo criado no sistema. Este parâmetro é lembrado como parte da autenticação criada.
Client Secret - é cadastrado o “Segredo do Cliente” do aplicativo criado no sistema. Este parâmetro é lembrado como parte da autenticação criada.
Exemplo de configuração:
Recebendo o token de acesso e o token de atualização
Em seguida, você precisa configurar as solicitações HTTP para receber o token de acesso e, se necessário, o token de atualização.
Caso o token precise ser atualizado, você precisa marcar a caixa Usar RefreshToken:
Esta caixa de seleção permite, na guia de resposta do primeiro widget de solicitação (que recebe o token de acesso), salvar o token de atualização recebido na resposta a uma variável:
Além disso, ao criar um widget de solicitação de atualização de token, essa variável estará disponível na guia Solicitação e o valor da variável (que salvamos anteriormente) será passado na solicitação de atualização de token.
*
Adicione um widget de solicitação para receber um token de acesso e configure-o conforme necessário para o sistema.
As seguintes variáveis dinâmicas estão disponíveis para a consulta:
Client ID - parâmetro que foi salvo como parte da autenticação.
Client Secret - parâmetro que foi salvo como parte da autenticação.
Redirect URI - URL de redirecionamento gerado, que está vinculado à autenticação criada.
Code - o código recebido na resposta, ao autorizar e conceder acesso.
Na guia de resposta, é necessário configurar o analisador de resposta para receber o token de acesso, atualizá-lo e salvá-lo nos campos criados anteriormente.
Se você precisar atualizar o token, adicione o mesmo widget de solicitação, na seção "Atualizar token". Nesta solicitação, você pode passar as mesmas variáveis dinâmicas, mas, além delas, também deverá informar o token de acesso obtido anteriormente e o token de atualização.
Descrição do mecanismo
Ao criar uma conexão com a aplicação, tal autenticação permite fornecer ao usuário final a URL pela qual ele concederá o acesso ao sistema. Então, a Albato retornará seu código temporário, que é trocado por um token de acesso.
Em seguida:
A solicitação de obtenção é feita assim que o usuário concede acesso, recebe os tokens necessários e os salva dentro da conexão.
Uma solicitação de atualização é feita no momento em que qualquer uma das entidades do aplicativo faz uma solicitação HTTP de saída e o aplicativo (serviço) retorna um erro indicando que o token expirou (deve haver um tratamento de erro com o tipo apropriado para o widget).
Atualizado em: 08/12/2022
Obrigado!