Aller à la documentation
SparkGlimSparkGlim Développeurs
Rechercher dans toute la documentation

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

    Référence API

    Ajouter un membre d’équipe Créateur

    Ajoute un membre via l’équipe Créateur et conserve la relation revendeur ; le membre suit l’intégration organisateur habituelle.

    POSThttps://api.sparkglim.net/api/white-label/portal/reseller/members

    Modèle d’accès

    Modèle d’accès
    Session SparkGlim et permissions de membre
    Portée requise
    members:write
    Disponibilité documentée
    Implémenté dans le code

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

    Utilisez le parcours de membre d’équipe Créateur. La revente ne donne jamais accès illimité à la base ou à l’administration.

    En-têtes

    NomTypeValidation
    AuthorizationObligatoire

    Session Bearer SparkGlim existante ; appartenance et capacités attribuées autorisent chaque opération côté serveur.

    stringValidation : Jeton Bearer d’une session authentifiée existante.

    Requête

    NomTypeValidation
    userIdFacultatif

    Association facultative à un utilisateur existant ; cette opération ne crée pas de compte Créateur illimité.

    string|nullValidation : UUID d’un utilisateur existant uniquement.
    creatorIdFacultatif

    Propriétaire d’équipe autorisé pour la relation revendeur ; valeur par défaut du propriétaire revendeur configuré.

    string|nullValidation : UUID du propriétaire autorisé ; créateur revendeur par défaut.
    memberTypeFacultatif

    Rôle de relation revendeur ; capacités attribuées et permissions d’équipe sont appliquées séparément.

    enumValidation : owner | operator | finance | support | sub_creator.
    statusFacultatif

    État de cycle pris en charge ; les règles d’approbation contrôlent encore publication et accès.

    enumValidation : invited | pending | active | suspended | revoked.
    displayNameFacultatif

    Nom affiché du membre ou contributeur, sans modifier la propriété du compte.

    string|nullValidation : 2–160.
    emailFacultatif

    Email de contact utilisé par le parcours configuré ; il ne donne jamais accès à lui seul.

    string|nullValidation : Adresse e-mail.
    phoneFacultatif

    Téléphone de contact du membre ou candidat utilisé par le parcours existant.

    string|nullValidation : 8–40.
    rolesFacultatif

    Rôles revendeurs acceptés par le schéma, limités séparément par les permissions serveur.

    string[]Validation : Rôles revendeur pris en charge.
    permissionsFacultatif

    Capacités prises en charge demandées, limitées par la politique du compte et l’autorisation de l’appelant.

    string[]Validation : Fonctionnalités revendeur prises en charge.
    otpRequiredFacultatif

    Définit la vérification prise en charge sans contourner les contrôles serveur.

    booleanValidation : Valeur par défaut : true.
    kycStatusFacultatif

    État de vérification de la relation revendeur ; n’autorise pas les paiements seul.

    enumValidation : not_required | pending | verified | rejected.
    metadataFacultatif

    Métadonnées JSON supplémentaires acceptées ; elles ne remplacent jamais autorisation, prix ou propriété.

    objectValidation : 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.

    POST /api/white-label/portal/reseller/members
    http
    POST /api/white-label/portal/reseller/members HTTP/1.1
    Host: api.sparkglim.net
    Authorization: Bearer <EXISTING_SESSION_TOKEN>
    Content-Type: application/json
    
    {
      "displayName": "Example member",
      "email": "member@example.com",
      "memberType": "sub_creator",
      "roles": [
        "sub_creator"
      ],
      "permissions": []
    }

    Réponse

    Réponse de succès · HTTP 201
    json
    {
      "success": true,
      "data": {
        "id": "11111111-1111-4111-8111-111111111111",
        "status": "pending"
      }
    }
    Réponse d’erreur · HTTP 400
    json
    {
      "success": false,
      "error": "<ERROR_MESSAGE>"
    }

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

    Limites et tentatives

    Limite serveur par défaut : 100 requêtes par IP sur 60 secondes. Des contrôles spécifiques s’appliquent.

    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/reseller-service.ts
    • server/src/white-label/schemas.ts