Resultado dos módulos

A Connect oferece uma rota para consultar os resultados dos módulos: por ID da Análise. Isso abrange tanto módulos assíncronos (como o MFA) quanto consultas posteriores de módulos síncronos (como Score e Insights).

Consulta por ID da Análise

Essa rota permite verificar o status de execução dos módulos contratados utilizando o ID da Análise.

📘

Endereço dos nossos serviços:

Homologação:

GET https://homologapix.clearsale.com.br/connect/v1/integration/analysis/[analysisId]

Produção:

GET https://apix.clearsale.com.br/connect/v1/integration/analysis/[analysisId]

Autenticação do Endpoint

O endpoint exige autenticação, o cliente deve fornecer as credenciais necessárias para que o sistema consiga realizar a autenticação e enviar os dados com sucesso.

O tipo de autenticação suportado é o Bearer Token (JWT).

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

📘

Informações sobre o processo de autenticação e obtenção do token podem ser consultados em Autenticação.

Response com erro

Representa os detalhes de um problema retornado pela API em caso de erro.

Tabela de Códigos HTTP

Representa os possíveis códigos HTTP de um problema retornado pela API em caso de erro.

JSON

{
    "title": "Fail to Validate Request.",
    "status": 400,
    "detail": "Invalid analysisId format. AnalysisId must be a valid Guid."
}

{
    "title": "Id not found",
    "status": 404,
    "detail": "Analysis 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' Not Found."
}

{
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
    "title": "Internal server error",
    "status": 500,
    "detail": "The server encountered an unexpected condition that prevented it from fulfilling the request",
    "traceId": "string"
}

Fluxo de Webhook

O webhook permite que o sistema envie notificações automáticas para um endpoint definido pelo cliente, sempre que uma determinada ação ou evento ocorrer em um dos módulos assíncronos. Essa funcionalidade é essencial para garantir que o cliente receba atualizações em tempo real, integrando os dados diretamente ao seu fluxo de negócio.

Para configurar um webhook, é necessário informar:

• A URL do endpoint que deve receber os dados.

Os módulos disponíveis são:

Fluxo de retentiva

Caso a URL do integrador retorne qualquer status HTTP diferente de 200 (OK), o sistema da Clearsale irá realizar novas tentativas de notificação para o mesmo pedido.

Essas retentivas continuarão ocorrendo até que uma resposta com status 200 seja recebida, indicando sucesso no processamento. O intervalo entre as tentativas será progressivamente aumentado, de acordo com o número de falhas anteriores, seguindo uma estratégia de backoff para evitar sobrecarga no sistema do integrador.

Autenticação do Endpoint

Caso o endpoint informado exija autenticação, o cliente deve fornecer as credenciais necessárias para que o sistema consiga realizar a autenticação e enviar os dados com sucesso. Os tipos de autenticação suportados são:

Basic Authentication O cliente deve informar usuário e senha, que serão convertidos em uma string Base64 e adicionados ao cabeçalho da requisição.

Onde dXN1YXJpbzpwYXNzZW5oYQ== é a codificação Base64 de usuario:senha.

Bearer Token (JWT) O cliente deve fornecer um token JWT válido.

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

🚧

Observação: O sistema não realiza a autenticação para geração do token.

API Key O cliente deve informar uma chave e um valor, que serão incluídos no cabeçalho da requisição como par key: value.

>

Request

POST https://exemplo-clearsale.com.br/analysis-result
Content-Type: application/json 

{
  "analysisId": "string",
  "date": "2025-09-26T17:21:11.0367845Z",
  "type": "mfa" //módulo
}