Documentação de utilização integração ClearSale para o produto Total e Total Garantido

TotalGarantido.md

Integração ClearSale

Total e Total Garantido

Liberando a funcionalidade via toggle

Para utilizar a integração ClearSale, por se tratar de um produto em fase de testes, necessita-se de ativação do merchant no toggle clearsale_integration. Para acessar ou criar um toggle basta:

• Acessar Configurações

• Clicar em Feature Togglers

• Procurar pelo toggle clearsale_integration

• Clicar em editar e inserir o id do merchant no campo expressão regular

Ativando a Integração

Após inserido o id do merchant no toggle, agora precisamos ativar a integração ClearSale. Para ativa-la, precisamos:

• Acessar Configurações

• Clicar em extensões e integrações

• Procurar pela integração ClearSale e clicar em instalar

• Na tela de instalação, selecionar o produto Total / Total Garantido e utilizar usuário e senha fornecido pela ClearSale e clique em instalar novamente

Para o ambiente de staging e sandbox podemos utilizar os dados:

Total / Total Garantido
Usuário: VindiEcommerce
Senha: jsg4Dp5
SLA Customizado: Você pode preencher este campo com um valor inteiro que corresponde a uma quantidade de minutos, porém em staging e em sandbox serve apenas para testarmos o envio do parametro `customSla` na requisição. Em produção este campo serve para customizar o tempo de analise junto da ClearSale e deve ser negociado previamene via contrato com a ClearSale.

Para o ambiente de produção é necessário requisitar dados para a ClearSale

• Assim fica a integração instalada

Obs: Note que após criada a integração possui o campo "URL do webhook", este campo deve ser fornecido para o cliente ou para a ClearSale pois será nessa URL que a ClearSale deverá responder os callbacks dessa integração

Utilizando a Integração

A integração atua em todas as transações feitas por cartão de crédito

Basta gerar uma fatura avulsa tendo seu pagamento utilizando cartão de crédito para que o serviço seja utilizado na verificação de fraude. A transação de autorização ficará com status de Suspeita de Fraude e aguardará a callback da ClearSale retornar para que verifiquemos a aprovação ou não do anti-fraude e assim continuarmos.

Simulando a Callback

A atualização do produto Total / Total Garantido funcionam assincronamente, ou seja, retornam via callbacks com URL pré cadastrada na ClearSale. Em produção precisaremos informar o valor do campo URL do webhook para a ClearSale automatizar a ação para o cliente. Como estamos em ambiente de testes, essa função torna-se manual no momento, ou seja, nós mesmos precisamos simular o retorno da ClearSale. Com isso precisaremos de uma ferramenta que simule envio de requisições em padrão restful como o Postman

Configurando o envio

• Com o Postman aberto, precisaremos do valor da URL do webhook

• No postman cole o valor da URL do webhook e selecione no canto esquerdo o valor escrito POST

• Depois selecione na aba escrita body

• Nela escolha o valor raw e no canto direito escolha JSON (application/json)

• Logo abaixo no campo em branco nós iremos inserir o JSON similar ao que a ClearSale nos enviaria.

{
	"code": "identificador de verificação anti-fraude presente na transação",
	"date": "data de hoje",
	"type": "status"
}

Por exemplo:

• O valor de code iremos inserir o valor de ID da análise presente na transação com status de suspeita de fraude que encontramos aqui:

• A data pode ser preenchida no seguinte formato, e com a data atual sem se preocupar com a hora: "2022-08-04T10:30:00.9931909-02:00"

• O type será sempre status por trantar-se de uma atualização de status.

Então nosso json ficará assim:

{
	"code": "8a59be16-e69b-4da3-a74e-978655328af0",
	"date": "2022-08-04T10:30:00.9931909-02:00",
	"type": "status"
}

• e nosso Postman deve ficar da seguinte forma:

Enviando

• Agora com tudo configurado iremos clicar no botão azul escrito send

• Após enviado os dados, deve ser retornado resposta do gateway.

• Tudo ocorrendo bem como o previsto, o gateway retornará uma mensagem para a plataforma que podermos ver no relatório de Histórico de Integrações

  • O status da verificação de fraude pode ser verificado clicando na lupa do dado.
  • No valor de conteúdo, procure por fraud_detector_response_fields e dentro dele procure por status ** Verificar este status e muito importante pois ele que implicará na atualização da transação, por exemplo, caso este valor seja reviewa transação permecerá em suspeita de fraude ate que um status diferente seja retornado. No ambiente de testes da ClearSale inclusive tem algumas transações q demoram a serem atualizadas os status.**

• Neste nosso exemplo a atualização de status deu-se como sucesso, portanto a transação foi atualiza e efetuado a captura.

• Os detalhes da verificação ficam nos detales da transação:

Para detalhes aprofundados e técnicos da comunicação com o anti-fraude é necessario acessar o transcript da Transação Clicando na lupa, abrirá os detalhes de todas as comunicações feitas para aquela transação.