Ir para a documentação
SparkGlimDeveloper
Centro de integração com IA
SparkGlimSparkGlim Programadores
Pesquisar em toda a documentação

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

    Navegação da documentação

    Referência API

    Estado público do bilhete

    Lê estado público de admissão do tenant sem registar entrada nem expor QR comprado.

    POSThttps://api.sparkglim.net/api/white-label/v1/tickets/verify

    Modelo de acesso

    Modelo de acesso
    Domínio verificado e chave pública limitada
    Âmbito necessário
    tickets:read
    Disponibilidade documentada
    Implementado no código

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

    A assinatura privada fica no servidor. A API Versão 1 usa assinatura v2; não é uma API v2.

    Cabeçalhos

    NomeTipoValidação
    x-white-label-domainObrigatório

    Domínio verificado que resolve a conta de Organização aprovada e vincula este pedido.

    		stringValidação: Nome de anfitrião HTTPS verificado.
    x-white-label-keyObrigatório

    Chave pública ou de campanha completa para o âmbito de leitura segura permitido.

    		stringValidação: Chave pública ou de campanha emitida no formato keyId:secret.

    Pedido

    NomeTipoValidação
    campaignIdObrigatório

    Campanha existente na conta e no âmbito mais limitado de qualquer credencial de campanha.

    		stringValidação: UUID obrigatório para procurar um bilhete no âmbito autorizado.
    ticketCodeObrigatório

    Credencial de bilhete existente na campanha autorizada para consulta ou admissão.

    		stringValidação: Credencial de bilhete; 3–120.

    Pedido

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

    POST /api/white-label/v1/tickets/verify
    http
    POST /api/white-label/v1/tickets/verify HTTP/1.1
Host: api.sparkglim.net
x-white-label-domain: events.example.com
x-white-label-key: <ISSUED_PUBLIC_OR_CAMPAIGN_KEY>
Content-Type: application/json

{
  "campaignId": "11111111-1111-4111-8111-111111111111",
  "ticketCode": "<EXISTING_TICKET_CODE>"
}

    Resposta

    Resposta de sucesso · HTTP 200
    json
    {
  "success": true,
  "data": {
    "status": "invalid",
    "message": "This ticket code is invalid."
  },
  "requestId": "wlapi_example"
}
    Resposta de erro · HTTP 400
    json
    {
  "success": false,
  "error": "<ERROR_MESSAGE>",
  "requestId": "wlapi_example"
}

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

    Limites e novas tentativas

    Organização: 120 pedidos por chave e 300 por IP por janela; respeite Retry-After e X-RateLimit.

    Compatibilidade do código

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

    • server/src/api/router.ts
    • server/src/api/routes/white-label.ts
    • server/src/white-label/auth.ts
    • server/src/white-label/schemas.ts
    • server/src/white-label/organization-service.ts
    • server/src/white-label/service.ts

    Continuar a desenvolver