Ir para a documentação
SparkGlimSparkGlim Programadores
Pesquisar em toda a documentação

Experimente um tema na sua língua ou um caminho API exato.

    Referência API

    Descoberta de campanhas públicas

    Pesquisa índice público estrito por produto, país, período, local e data; devolve paginação exata e dados permitidos.

    GEThttps://api.sparkglim.net/api/public/homepage/discovery

    Modelo de acesso

    Modelo de acesso
    Acesso público com validação
    Disponibilidade documentada
    Implementado no código

    Disponibilidade verificada no código, sem garantia de produção.

    Devolva apenas registos permitidos por conta, campanha e visibilidade.

    Parâmetros

    NomeTipoValidação
    qOpcional

    Texto pesquisado em título, descrição, organizador, local ou beneficiário públicos.

    stringValidação: <=100.
    countryOpcional

    Filtro pelo país configurado da campanha; não ativa pagamentos nem converte moeda.

    stringValidação: ISO2.
    locationOpcional

    Local público ou filtro; separado do país financeiro de venda.

    stringValidação: <=100.
    typeOpcional

    Tipo de recurso, reação ou filtro de campanha suportado aqui.

    enumValidação: all | ticketing | voting | donation.
    statusOpcional

    Estado suportado pedido; aprovação controla publicação e acesso.

    enumValidação: all | active | upcoming | ended | postponed.
    sortOpcional

    Seleciona ordem do servidor: destaques, recentes ou fecho.

    enumValidação: featured | latest | ending.
    dateOpcional

    Limita pesquisa à janela de data documentada do filtro existente.

    enumValidação: all | today | tomorrow | weekend | month.
    pageOpcional

    Página pedida conforme numeração documentada; preserve metadados do servidor.

    integerValidação: 1–1000000.
    limitOpcional

    Máximo de registos na página; aplica-se o limite fixo do endpoint.

    integerValidação: 1–24; valor predefinido: 12.

    Pedido

    Os exemplos descrevem o contrato e não são executados. Use registos de teste autorizados; nunca cole segredos reais aqui.

    GET /api/public/homepage/discovery
    http
    GET /api/public/homepage/discovery HTTP/1.1
    Host: api.sparkglim.net

    Resposta

    Resposta de sucesso · HTTP 200
    json
    {
      "success": true,
      "data": {
        "entries": [],
        "countries": [],
        "locations": [],
        "pagination": {
          "page": 1,
          "limit": 12,
          "total": 0,
          "pages": 0,
          "hasMore": false
        },
        "available": true
      }
    }
    Resposta de erro · HTTP 400
    json
    {
      "success": false,
      "error": "<ERROR_MESSAGE>"
    }

    Validação, permissões, registos indisponíveis e falhas usam estado HTTP e erro do controlador.

    Limites e novas tentativas

    Limite padrão: 100 pedidos por IP em 60 segundos. Aplicam-se também controlos específicos.

    Compatibilidade do código

    As operações autorizadas exigem testes específicos da conta.

    • server/src/api/routes/public-homepage.ts