CLEARSALE

Solicitar Super API

A Super API foi criada para evoluir a experiência do cliente e simplificar sua integração ou migração dos produtos legados para a Plataforma Data Trust.

"Super API" é uma forma de integração da Plataforma Data Trust que permite através de uma integração simplificada o retorno de "N" módulos de uma só vez, apenas se autenticando na Plataforma e gerando uma transação no endpoint do da Super API, previamente configurado para a sua empresa.

Para criar uma Super API, basta enviar para o e-mail: [email protected]:

  • Os módulos que farão parte do empacotamento da Super API, podendo ser inicialmente os módulos: Score de Fraude, Vínculos (ratings), Insights, 2FA (SMS, e-mail e WhatsApp), Token (SMS e e-mail) e módulos do Credit Pro (Score de Crédito), Device Check, Laranja e Trustcard;
  • O nome do endpoint da Super API. O nome escolhido pelo cliente definirá a rota do endpoint;
  • Cada cliente poderá ter 'N' endpoints com empacotamentos distintos;

Todos os resultados e atualizações que ocorrerem dentro do empacotamento serão notificados via Webhook (Para módulos que necessitam de iteração do cliente, como 2FA e Token);

O Transaction id gerado pela Super API poderá ser usado posteriormente para chamar outros módulos que ainda não estão disponíveis através do empacotamento mas que estão disponíveis para consumo na Plataforma Data Trust de forma modularizada.

📘

Endereço dos nossos serviços:

Homologação: POST [https://datatrustapihml.clearsale.com.br/v1/packs/{packName}
Produção: POST [https://datatrustapi.clearsale.com.br/v1/packs/{packName}

Acesse aqui a documentação técnica

Dicionário de variáveis

Super API

NomeDescriçãoTipo
CreatedAtData da criação do PackDateTime
StatusEstado atual do Pack (Completed ou Error)String
TransactionDados transacionadosTransaction
ScoreResultado do scoreModule
RatingResultado dos ratingsModule
InsightInsights geradosModule
SmsTokenConfirma o envio do token via smsModule
EmailTokenConfirma o envio do token via emailModule
SmsTwoFactorAuthenticationConfirma o envio do 2FA via smsModule
EmailTwoFactorAuthenticationConfirma o envio do 2FA via emailModule
WhatsappTwoFactorAuthenticationConfirma o envio do 2FA via WhatsappModule
CreditResultado de credit proModule
Device CheckResultado Device CheckModule
LaranjaResultado LaranjaModule
TrustcardResultado TrustcardModule
Obs: O Objeto do tipo Module só será devolvido caso o empacotamento seja do Tipo Síncrono.

Module

NomeDescriçãoTipo
ResultsResultado do módulo: verifique a lista de módulos disponíveis para conferir o objeto que cada módulo retornaString
StatusEstado atual do móduloString
ErrorMessageDescreve o erro do móduloString

Módulos Disponíveis