Référence API

Campagnes approuvées

Liste les campagnes approuvées de l’organisation, limitées éventuellement par campaignId. Les privées exigent une clé de campagne explicite correspondante.

GEThttps://api.sparkglim.net/api/white-label/v1/campaigns

Modèle d’accès

Modèle d’accès: Domaine vérifié et clé publique limitée
Portée requise: campaigns: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

Nom	Type	Validation
`x-white-label-domain`Obligatoire Domaine vérifié qui résout le compte Organisation approuvé et lie cette requête.	`string`	Validation : Nom d’hôte HTTPS vérifié.
`x-white-label-key`Obligatoire Clé publique ou de campagne complète pour le périmètre de lecture sûre autorisé.	`string`	Validation : Clé publique ou de campagne émise au format keyId:secret.

Paramètres

Nom	Type	Validation
`campaignId`Facultatif Campagne existante dans le compte et dans tout périmètre de clé de campagne plus limité.	`string`	Validation : UUID dans le périmètre de la clé.

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.

GET /api/white-label/v1/campaigns

http

GET /api/white-label/v1/campaigns HTTP/1.1
Host: api.sparkglim.net
x-white-label-domain: events.example.com
x-white-label-key: <ISSUED_PUBLIC_OR_CAMPAIGN_KEY>

Réponse

Réponse de succès · HTTP 200

json

{
  "success": true,
  "data": [],
  "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