Référence API

Modifier un participant

Modifie uniquement un participant de l’organisation en conservant les contrôles de campagne et d’approbation.

PATCHhttps://api.sparkglim.net/api/white-label/v1/participants/:participantId

Modèle d’accès

Modèle d’accès: HMAC Organisation côté serveur
Portée requise: campaigns:write
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-id`Obligatoire Identifiant extrait de la clé privée unique ; n’envoyez jamais son secret dans cet en-tête.	`string`	Validation : Identifiant interne de la clé privée émise.
`x-white-label-signature-version`Obligatoire Sélectionne le format signé lié au domaine ; les routes API restent Version 1.	`string`	Validation : 2.
`x-white-label-timestamp`Obligatoire Heure de signature en millisecondes comparée à l’horloge serveur pour rejeter les requêtes périmées.	`string`	Validation : Millisecondes sur 13 chiffres ; dans une fenêtre de cinq minutes.
`x-white-label-nonce`Obligatoire Valeur aléatoire fraîche enregistrée par le serveur pour empêcher la répétition d’une requête signée.	`string`	Validation : Valeur nouvelle : 16–128 [A-Za-z0-9_-].
`x-white-label-signature`Obligatoire HMAC-SHA256 du domaine, clé d’idempotence, clé de campagne, horodatage, nonce, méthode, chemin, requête triée et empreinte exacte du corps.	`string`	Validation : HMAC-SHA256 hexadécimal en minuscules.
`x-white-label-campaign-key`Facultatif Clé de campagne complète facultative qui limite la requête privée à la même campagne autorisée.	`string`	Validation : Valeur keyId:secret complète, facultative et limitée à son périmètre.

Paramètres

Nom	Type	Validation
`participantId`Obligatoire Candidat choisi dans cette campagne ; approbation et règles sont vérifiées par le serveur.	`string`	Validation : UUID ou identifiant de ressource documenté.

Requête

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.
`name`Facultatif Nom affiché du type de billet ou participant géré.	`string`	Validation : 2–160.
`categoryId`Facultatif Catégorie existante de cette campagne, jamais d’un autre compte ou d’une autre campagne.	`string\|null`	Validation : UUID.
`bio`Facultatif Biographie du candidat fournie par l’organisateur autorisé.	`string\|null`	Validation : <=5000.
`phoneNumber`Facultatif Téléphone du participant ; les moyens de paiement et règles peuvent exiger un numéro international valide.	`string\|null`	Validation : <=32.
`imageUrl`Facultatif URL de l’image fournie ; utilisez un média public autorisé.	`string\|null`	Validation : URL.
`applicationStatus`Facultatif État d’approbation du candidat accepté par le contrat Organisation.	`enum`	Validation : pending \| approved \| rejected.
`metadata`Facultatif Métadonnées JSON supplémentaires acceptées ; elles ne remplacent jamais autorisation, prix ou propriété.	`object`	Validation : Objet JSON.

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.

PATCH /api/white-label/v1/participants/:participantId

http

PATCH /api/white-label/v1/participants/11111111-1111-4111-8111-111111111111 HTTP/1.1
Host: api.sparkglim.net
x-white-label-domain: events.example.com
x-white-label-key-id: <ISSUED_KEY_ID>
x-white-label-signature-version: 2
x-white-label-timestamp: <FRESH_MILLISECONDS>
x-white-label-nonce: <FRESH_SIGNING_NONCE>
x-white-label-signature: <SERVER_GENERATED_SIGNATURE>
Content-Type: application/json

{
  "bio": "Example biography"
}

Réponse

Réponse de succès · HTTP 200

json

{
  "success": true,
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "status": "pending"
  },
  "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

Modèle d’accès

En-têtes

Paramètres

Requête

Requête

Réponse

Limites et tentatives

Compatibilité du code

Poursuivre le développement