Integração
Documentação para a integração de pedidos (transacional) da Connect.
POST Integration/{integrationId}
{integrationId}A rota /Integration/integrationId permite integrar informações específicas de uma transação identificada pelo integrationId.
Ela recebe dados detalhados sobre a transação, como valores, dispositivos, informações de cobrança e envio, além de itens e pagamentos. Após o processamento, a rota retorna uma análise com resultados, incluindo decisões, verificações biométricas e insights. É necessário autenticar-se com um token de segurança para utilizá-la.
Identificação de Integração por Módulo
Cada módulo do sistema possui um integrationId específico que o identifica de forma única, são eles:
Observação: É possível compor múltiplos módulos, o que proporciona maior flexibilidade e granularidade na integração entre funcionalidades, permitindo atender a cenários mais complexos de forma eficiente.
Módulos Síncronos e Assíncronos
Funcionamento de Módulos Síncronos
Os módulos síncronos, realizam a análise dos dados imediatamente após o recebimento de uma solicitação. Esse processo envolve o cruzamento de múltiplas informações relevantes, com o objetivo de calcular o score e determinar o status da requisição.
A resposta da análise é retornada em questão de segundos, permitindo decisões rápidas e integradas ao fluxo da aplicação, sem a necessidade de processamento assíncrono ou espera prolongada.
Funcionamento de Módulos Assíncronos
Os módulos assíncronos processam as solicitações de forma não imediata, permitindo que a análise dos dados ocorra em segundo plano após o recebimento da requisição. Durante esse processo, são cruzadas diversas informações relevantes para o cálculo do score e a definição do status da solicitação.
Após a conclusão do processamento, o sistema realiza uma notificação automática via webhook, enviando os resultados para o endpoint previamente disponibilizado pelo cliente.
Endereço dos nossos serviços:
Homologação:
POST https://homologapix.clearsale.com.br/connect/v1/integration/integrationId
Produção:
POST https://apix.clearsale.com.br/connect/v1/integration/integrationId
Configuração para Ambiente de Homologação
O ambiente de Homologação é utilizado para testes de integração entre sistemas. Por padrão, os retornos são gerados com valores fixos, mas é possível solicitar configurações customizadas nos módulos que oferecem essa opção.
A definição do score e do status é baseada no dígito final do campo numérico presente no documento de billing, permitindo simular diferentes cenários de forma controlada.
Módulos Disponíveis
- Decision (padrão e customizado)
- Score (padrão e customizado)
- MFA (padrão)
- Biolink (padrão e customizado)
- Insights (padrão)
Configuração Padrão do Score
| Documento (dígito final) | Faixa de Score (Gerado aleatoriamente) |
|---|---|
| 0 | 0.0000 – 0.1000 |
| 1 | 0.1001 – 0.2000 |
| 2 | 0.2001 – 0.3000 |
| 3 | 0.3001 – 0.4000 |
| 4 | 0.4001 – 0.5000 |
| 5 | 0.5001 – 0.6000 |
| 6 | 0.6001 – 0.7000 |
| 7 | 0.7001 – 0.8000 |
| 8 | 0.8001 – 0.9000 |
| 9 | 0.9001 – 0.9999 |
Configuração Padrão do Status
| Documento (dígito final) | Status |
|---|---|
| 0 | APA – Aprovação Automática |
| 1 | RPA – Reprovação Automática |
| 2 | AMA – Em Fila |
| 3 | FRD – Fraude Confirmada |
| 4 | APM – Aprovado |
| 5 | APP – Aprovado por Política |
| 6 | AME – Análise Manual Externa |
| 7 | APB – Aprovado por Biometria |
| 8 | APS - Aprovado por SMS |
| 9 | ACT - Aprovado por Contingência |
Configuração de Webhook
Para os módulos MFA e Biolink, é possível configurar um webhook para receber notificações ou resultados diretamente em um endpoint definido pelo cliente.
Essa funcionalidade permite:
- Integração em tempo real com sistemas internos.
- Automação de processos baseados nos eventos retornados.
- Maior controle sobre os testes e respostas do ambiente de homologação.
Para habilitar o webhook, informe:
- URL do endpoint que receberá as requisições.
- Formato esperado JSON.
- Autenticação, caso necessária (Basic, ApiKey, Jwt).
Updated 2 days ago