O que é o Credential Helper?

O Credential Helper é um serviço disponível na plataforma TOTVS Apps para uso pelos ERPs e outras aplicações TOTVS que necessitem obter credenciais (client ID e client secret) para habilitar a comunicação com a solução SmartLink.    

https://tdn.totvs.com/pages/viewpage.action?pageId=890537799

Funcionamento do Credential Helper

https://tdn.totvs.com/pages/viewpage.action?pageId=895602961
    

Com o uso do Credential Helper, o tempo entre solicitar a geração de credenciais e ter a aplicação conectada ao SmartLink foi reduzido para minutos. Além disso, o processo é automatizado, requerendo interação com o usuário final somente quando estritamente necessário.  

Quando a chamada do Credential Helper é realizada no Protheus?

...

Sempre que um ambiente é aberto uma verificação é feita para determinar se a solicitação ao credential helper deve ser realizada.

Requsitos para execução:

• Se o ambiente não possui credenciais cadastradas.
• Não é um ambiente de desenvolvimento.
• Não é um ambiente PDV.

A cada solicitação é contabilizada contabilizado um espaço de uma hora para que outra solicitação seja iniciada e isso é verificado antes de realizar a execução.

...

, ou seja, a cada uma hora a solicitação pode ser realizada.

Expandir
title Fluxo da chamada do Credential Helper
Image Added

Funcionamento da solicitação no Protheus

Ao verificar que a chamada do credential helper será realizada, algumas informações são recuperadas para realização da solicitação:

• TotvsId e código de instalação.
• Hash único do ambiente
• Tipo do ambiente em uso: Desenvolvimento, Homologação ou Produção

O Protheus aciona o Credential Helper solicitando a geração das credenciais enviando o contexto recuperado.

Retorno da solicitação

A solicitação quando retornada traz o status em que se encontra a solicitação:

• Processo de solicitação de credenciais finalizado
  • O processo foi finalizado e as credenciais geradas são gravadas.
• Processo de solicitação de credenciais em andamento
  • Nesse status a solicitação gerada ainda não foi concluída pelo credential helper.
• Falha no processo de solicitação de credenciais
  • Caso exista algum erro na geração o credential helper retorna o resultado para avaliação, qualquer dúvida consultar os retornos da documentação.
• Wizard de credenciais deverá ser aberto para classificação de ambiente
  • Caso o Credential Helper identifique a necessidade de interação do usuário no configurador smartlink.

Wizard de Configuração SmartLink

Caso, após a chamada do endpoint de geração de credenciais, o Credential Helper identifique a necessidade de interação do usuário será retornado a indicação de que será preciso executar o wizard do Credential Helper.
    
No configurador insira uma nova opção no menu do SIGACFG com a função CFGWizardCHApp para possibilitar a abertura do configurador do smartlink : https://tdn.totvs.com/display/public/FWCH/Configurador+do+SmartLink. 
    
É possível gerar novas credenciais para um determinado ambiente que irá iniciar uma nova solicitação, essa task solicitação é acompanhada conforme o fluxo de funcionamento da solicitação de credenciais.

...

Sincronização de credenciais

Considerando que o ERP Protheus já possua credenciais e a comunicação com o SmartLink já esteja funcionando, em uso e que essas credenciais foram obtidas de forma distinta do Credential Helper, a sincronização será realizada.

A sincronização é realizada https://tdn.totvs.com/pages/viewpage.action?pageId=895602961para que o controle do Credential Helper esteja atualizado com as credencias em uso para demais validações.

Onde o fluxo do Credential Helper também é usado?

Quando há credenciais inválidas para autenticação

Quando as credenciais em uso estão inválidas na plataforma de autenticação, é retornado durante sua utilização no ERP essa informação. Nesse cenário, essas credenciais são limpas e uma nova solicitação é iniciada por meio do fluxo do Credential Helper.

Consulte a seção Falha na autenticação na documentação de Autenticação

Durante a validação de hash do ambiente

As credenciais em uso são validadas na plataforma de acordo com o ambiente ativo. Caso seja identificado que essas credenciais são inválidas para esse ambiente, elas são removidas e uma nova solicitação é iniciada por meio do fluxo do Credential Helper.

Para mais detalhes, consulte a documentação de Validação por hash do ambiente