A "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. Basta se autenticar na Plataforma e gerar uma transação no endpoint da Super API, previamente configurado para a sua empresa.

Quando a funcionalidade de orquestração estiver ativada, a Super API poderá não devolver todos os resultados de uma vez. Nesse caso, os módulos serão executados conforme as regras de orquestração definidas, realizando as chamadas de forma automática e conforme a necessidade.

Fluxos da Super API

A Super API possui dois fluxos distintos:

• Super Api execução completa: Este fluxo executa todos os módulos de uma vez, retornando os resultados de todos os módulos configurados em uma única chamada.
• Super API com orquestração (funcionalidade de orquestração ativada): Este fluxo executa os módulos conforme as regras de orquestração definidas entre cliente e Clearsale, realizando as chamadas de forma automática e conforme a necessidade, baseando-se nas condições e regras definidas.

Como Solicitar a Criação de uma Super API

Para utilizar a Super API criaremos uma URL exclusiva para você, basta enviar um e-mail para suporte@clear.sale com as seguintes informações:

• 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;
• Uso da funcionalidade de Orquestração: Caso o cliente opte por utilizar a funcionalidade de Orquestração, será necessário informar essa escolha por e-mail e alinhar as regras de orquestração que deverão ser cadastradas. Por favor, nos comunique sobre essa necessidade para que possamos entrar em contato e definir as regras detalhadamente.
• 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.
• Notificações e Atualizações - Todos os resultados e atualizações que ocorrerem dentro do empacotamento serão notificados via Webhook (para módulos que necessitam de interação do cliente, como 2FA e Token).

Uso do Transaction IDO 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.