📘

Endereço dos nossos serviços:

Homologação: POST https://datatrustapihml.clearsale.com.br/v1/transaction/{id}/sms/2fa

Produção: POST https://datatrustapi.clearsale.com.br/v1/transaction/{id}/sms/2fa

Acesse aqui a documentação técnica

O módulo 2FA tem retorno assíncrono, depende de ação do seu cliente para que se obtenha a resposta da mensagem. Primeiro faça a chamada do módulo (método POST) para que possamos enviar a mensagem ao seu cliente, depois, faça a consulta do resultado utilizando o método GET. Você também pode implementar um Webhook para ser notificado quando o resultado estiver pronto!

Dicionário de variáveis

Status

*Obs : Somente os status Replied, Expired e Failed contemplam envio de Webhook.

Nome enviado na mensagem

No caso do cliente ter enviado o campo 'name' através do endpoint de transação, o nome enviado na mensagem de SMS será exatamente o que foi enviado pelo cliente, sem possibilidade de adaptações.

No caso do cliente não ter enviado o campo 'name' através do endpoint de transação, o fluxo interno de busca de nome no Datalake ClearSale é acionado. Para o fluxo interno, será possível realizar a adaptação de enviar apenas o primeiro nome ou o nome + sobrenome (último nome) do usuário final na mensagem SMS. Para solicitar essa adaptação, entre em contato com [email protected]. No caso da ClearSale não encontrar o nome**, a mensagem será enviada apenas com "Prezado(a)", sem nome, dessa forma garantiremos que mesmo assim a mensagem seja enviada com sucesso.

Envio de SMS com templates distintos (ChannelID)

É possível cadastrar SMS com parâmetros distintos, para isso, o cliente deverá solicitar ao [email protected] o cadastro dos SMS, informando quais parâmetros deverão ser cadastrados para cada fluxo. Como retorno, o suporte devolverá quais 'channelID' correspondem a cada fluxo do cliente.

Quais são os parâmetros que o cliente deve cadastrar para o 2FA SMS?

• text - Texto enviado através da mensagem
• expirationTime - Tempo que o usuário final tem para responder o SMS
• smsSendLimit

Para enviar um SMS respeitando os parâmetros atrelados ao channelID

• Criar a transação passando todos os dados necessários + o campo channelID
• Usando o ID da transação criada, realizar chamada no endpoint de 2FA SMS
• Sucesso! O SMS será enviado de acordo com o que foi cadastrado para o channelID

*O channelID é o fator determinante para que a ClearSale envie o SMS de acordo com o que o cliente precisa.

Campos Genéricos (genericFields)

A inclusão de campos genéricos foi pensada para que o cliente possa inserir nas mensagens de texto de 2FA sms *Ainda não disponível para o fluxo de email), variáveis que somente o cliente tem acesso e que façam sentido para o entendimento do contexto da mensagem pelo seu usuário final.

Para o envio de campos genéricos para uso na mensagem de 2FA é necessário alinhamento prévio, para que então o campo passe a ser considerado no envio da transação.

Uma vez que os campos estejam mapeados, é possível adicionar uma máscara para validar o dado enviado, como por exemplo enviar somente letras, enviar uma data, um valor monetário, etc.

Se você tem interesse em enviar campos genéricos na mensagem de 2FA entre em contato com o [email protected]