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

    Mettre une notification configurée en attente

    Envoie email ou SMS activé avec expéditeur configuré et retourne enregistrement et résultat de livraison.

    POSThttps://api.sparkglim.net/api/white-label/v1/notifications

    Modèle d’accès

    Modèle d’accès
    HMAC Organisation côté serveur
    Portée requise
    notifications: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

    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-key-idObligatoire

    Identifiant extrait de la clé privée unique ; n’envoyez jamais son secret dans cet en-tête.

    		stringValidation : Identifiant interne de la clé privée émise.
    x-white-label-signature-versionObligatoire

    Sélectionne le format signé lié au domaine ; les routes API restent Version 1.

    		stringValidation : 2.
    x-white-label-timestampObligatoire

    Heure de signature en millisecondes comparée à l’horloge serveur pour rejeter les requêtes périmées.

    		stringValidation : Millisecondes sur 13 chiffres ; dans une fenêtre de cinq minutes.
    x-white-label-nonceObligatoire

    Valeur aléatoire fraîche enregistrée par le serveur pour empêcher la répétition d’une requête signée.

    		stringValidation : Valeur nouvelle : 16–128 [A-Za-z0-9_-].
    x-white-label-signatureObligatoire

    HMAC-SHA256 du domaine, clé d’idempotence, clé de campagne, horodatage, nonce, méthode, chemin, requête triée et empreinte exacte du corps.

    		stringValidation : HMAC-SHA256 hexadécimal en minuscules.
    x-white-label-campaign-keyFacultatif

    Clé de campagne complète facultative qui limite la requête privée à la même campagne autorisée.

    		stringValidation : Valeur keyId:secret complète, facultative et limitée à son périmètre.

    Requête

    NomTypeValidation
    channelObligatoire

    Canal de livraison ou intégration pris en charge par cette opération et la configuration activée.

    		enumValidation : email | sms.
    eventTypeObligatoire

    Événement, objet ou données de notification acceptés par le parcours de livraison activé.

    		stringValidation : 1–120.
    recipientObligatoire

    Contact destinataire de la notification autorisée ou du défi de vérification.

    		stringValidation : 3–255.
    subjectFacultatif

    Événement, objet ou données de notification acceptés par le parcours de livraison activé.

    		string|nullValidation : <=255.
    payloadFacultatif

    Événement, objet ou données de notification acceptés par le parcours de livraison activé.

    		objectValidation : Données d’événement configurées.

    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/notifications
    http
    POST /api/white-label/v1/notifications 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

{
  "channel": "email",
  "eventType": "<CONFIGURED_EVENT>",
  "recipient": "member@example.com",
  "payload": {}
}

    Réponse

    Réponse de succès · HTTP 202
    json
    {
  "success": true,
  "data": {
    "record": {
      "id": "11111111-1111-4111-8111-111111111111"
    },
    "result": {}
  },
  "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