Aller à la documentation
SparkGlimDeveloper
Espace d’intégration avec l’IA
SparkGlimSparkGlim Développeurs
Rechercher dans toute la documentation

Essayez un sujet dans votre langue ou un chemin API exact.

    Navigation de la documentation

    Référence API

    Statut public du billet

    Lit le statut d’admission public limité au tenant sans enregistrer l’entrée ni exposer le QR acheté.

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

    Modèle d’accès

    Modèle d’accès
    Domaine vérifié et clé publique limitée
    Portée requise
    tickets:read
    Disponibilité documentée
    Implémenté dans le code

    La disponibilité est vérifiée dans le code, pas garantie en production.

    La signature privée reste sur votre serveur. L’API Version 1 utilise le format de signature v2 ; ce n’est pas une API v2.

    En-têtes

    NomTypeValidation
    x-white-label-domainObligatoire

    Domaine vérifié qui résout le compte Organisation approuvé et lie cette requête.

    		stringValidation : Nom d’hôte HTTPS vérifié.
    x-white-label-keyObligatoire

    Clé publique ou de campagne complète pour le périmètre de lecture sûre autorisé.

    		stringValidation : Clé publique ou de campagne émise au format keyId:secret.

    Requête

    NomTypeValidation
    campaignIdObligatoire

    Campagne existante dans le compte et dans tout périmètre de clé de campagne plus limité.

    		stringValidation : UUID requis pour rechercher un billet dans le périmètre autorisé.
    ticketCodeObligatoire

    Identifiant de billet existant dans la campagne autorisée pour lecture ou admission autorisée.

    		stringValidation : Identifiant d’accès au billet ; 3–120.

    Requête

    Les exemples décrivent le contrat et ne sont pas exécutés. Utilisez des données de test autorisées ; ne saisissez jamais de secret réel ici.

    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>"
}

    Réponse

    Réponse de succès · HTTP 200
    json
    {
  "success": true,
  "data": {
    "status": "invalid",
    "message": "This ticket code is invalid."
  },
  "requestId": "wlapi_example"
}
    Réponse d’erreur · HTTP 400
    json
    {
  "success": false,
  "error": "<ERROR_MESSAGE>",
  "requestId": "wlapi_example"
}

    Validation, permissions, données indisponibles et pannes utilisent le statut HTTP et l’erreur du gestionnaire.

    Limites et tentatives

    Limiteur Organisation : 120 requêtes par clé et 300 par IP par fenêtre ; respectez Retry-After et X-RateLimit.

    Compatibilité du code

    Les opérations autorisées nécessitent des tests propres au compte.

    • 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

    Poursuivre le développement