Disponível a partir do pacote Smartlink 2.5.7

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.

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.

Para mais informações acesse a documentação com todas as informações do Credential Helper.

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.

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

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

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 task gerada ainda não foi concluída pelo credential helper, no processo padrão essa consulta seria feita a cada uma hora até a solicitação ter um retorno.

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 https://tdn.totvs.com/pages/viewpage.action?pageId=895602961.

Para mais detalhes do processo no credential helper acesse a documentação do fluxo de operação ao receber a solicitação.

Wizard de configuração

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 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 é acompanhada conforme o fluxo de solicitação de credenciais.

Fluxo de sincronização de credenciais

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

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