Mental Model (Fluxo Assíncrono)

O Equals Connect é capaz de lidar com alto volume de dados, pois busca e formata os dados de maneira assíncrona e sob demanda.

Jornada de Integração (Produção)

1. Solicitação: Você pede um relatório. A API responde com um id.
2. Processamento: A Equals processa em background.
3. Notificação: Assim que pronto, enviamos um Webhook informando que a página está disponível.
4. Consumo: Sua aplicação baixa os dados em lotes (paginação).

Jornada de Integração (Sandbox)

1. Solicitação: Você pede um relatório. A API responde com um id.
2. Download Imediato: Os dados mockados já estão disponíveis - faça o download diretamente.
3. Polling (opcional): Se quiser simular, use GET /retornos?id={ID}.

Webhooks estão disponíveis APENAS em Produção. No Sandbox, utilize Polling.

Status da Remessa

Status	Descrição
AGUARDANDO_PROCESSAMENTO	Na fila para processamento
EM_PROCESSAMENTO	Dados sendo extraídos

Resposta (Produção):

{
  "id": 7000000001110834,
  "situacao": "CONCLUIDO",
  "tipoRemessa": "Vendas - Equals (API)",
  "quantidadePaginas": 45
}

Resposta (Sandbox):

{
  "id": 4000000000476410,
  "situacao": "EM_PROCESSAMENTO",
  "tipoRemessa": "Vendas - Equals (API)",
  "quantidadePaginas": null
}

[!WARNING] Atenção (Sandbox): No ambiente de homologação, o campo situacao é fixo como EM_PROCESSAMENTO e quantidadePaginas retorna null. Os dados já estão disponíveis para download - não espere o status mudar.

| CONCLUIDO | Remessa pronta para download | | ERRO | Falha na geração |

---

Diferença Importante: Sandbox

No ambiente Sandbox, o status é FIXO como EM_PROCESSAMENTO e NUNCA muda para CONCLUIDO.

Isso é intencional para facilitar testes. Os dados mockados já estão disponíveis imediatamente após a geração.

Fluxo no Sandbox:

1. Gere a remessa Receba o id
2. Pule a verificação de status
3. Faça o download dos dados imediatamente

Fluxo na Produção:

1. Gere a remessa Receba o id
2. Aguarde o status CONCLUIDO (via polling ou webhook)
3. Faça o download dos dados

Paginação

• Limite: 1.000 registros por página
• Término: Quando uma página retornar registros vazios