Documentação da Integração

Integração externa da lista de espera e anexos

Esta página documenta as rotas privadas de integração para consumo da lista de espera completa, catálogo de filtros e obtenção de links temporários de anexos.

Base detectada neste acesso: https://inscricoes.sistemasemeccruzeiro.com.br

1. Pré-requisito

O sistema consumidor precisa estar em um origin cadastrado e ativo na administração. Sem isso, as rotas respondem com bloqueio por STRICT_ORIGIN_REQUIRED.

2. Fluxo recomendado

Consulte primeiro o catálogo, descubra escolas, etapas e referências, depois busque a exportação completa e por fim obtenha o link temporário dos anexos desejados.

3. Ambiente local

No ambiente local, os exemplos usam automaticamente http quando o host é localhost ou termina com .local.

Rotas disponíveis

Catálogo de filtros e referências

Retorna as escolas, etapas, tipos de documento, status e a descrição dos campos do payload para orientar o consumidor da integração.

GET https://inscricoes.sistemasemeccruzeiro.com.br/api/integracoes/lista-espera/catalogo

Exportação completa da lista

Retorna a lista de espera com o cadastro completo e os documentos vinculados. Filtros opcionais: escola_id, etapa e protocolo.

GET https://inscricoes.sistemasemeccruzeiro.com.br/api/integracoes/lista-espera?escola_id={id}&etapa={slug}&protocolo={valor}

Link temporário do anexo

Usa o documento_id vindo em documentos[] da exportação e devolve uma URL assinada para acesso temporário ao arquivo.

GET https://inscricoes.sistemasemeccruzeiro.com.br/api/integracoes/anexos/{documento_id}

Exemplo de consumo

Chame o catálogo para descobrir filtros e referências.
Escolha uma escola e uma etapa retornadas no catálogo.
Chame a exportação completa com os filtros desejados.
Leia documentos[].id de cada inscrição e use a rota de anexos quando precisar do arquivo.

1. Descoberta do catálogo

fetch('https://inscricoes.sistemasemeccruzeiro.com.br/api/integracoes/lista-espera/catalogo', {
  method: 'GET',
  credentials: 'include',
});

2. Exportação da lista

fetch('https://inscricoes.sistemasemeccruzeiro.com.br/api/integracoes/lista-espera?escola_id=UUID_DA_ESCOLA&etapa=slug-da-etapa', {
  method: 'GET',
  credentials: 'include',
});

3. Anexo por documento

fetch('https://inscricoes.sistemasemeccruzeiro.com.br/api/integracoes/anexos/UUID_DO_DOCUMENTO', {
  method: 'GET',
  credentials: 'include',
});

Contrato resumido

Resposta resumida do catálogo

{
  "success": true,
  "data": {
    "rotas": {
      "catalogo": "https://inscricoes.sistemasemeccruzeiro.com.br/api/integracoes/lista-espera/catalogo",
      "exportacao": "https://inscricoes.sistemasemeccruzeiro.com.br/api/integracoes/lista-espera",
      "anexos": "https://inscricoes.sistemasemeccruzeiro.com.br/api/integracoes/anexos/{documento_id}"
    },
    "filtros": {
      "escolas": [],
      "etapas": []
    },
    "referencias": {
      "status_inscricao": [],
      "tipos_documento": [],
      "status_documento": []
    }
  }
}

Resposta resumida do anexo

{
  "success": true,
  "data": {
    "url": "https://...assinada...",
    "documento": {
      "id": "uuid",
      "nome_arquivo": "arquivo.pdf",
      "mime_type": "application/pdf"
    }
  }
}