Si votre site Web propose des abonnements, des programmes ou des produits, vous pouvez décider à quels groupes d'utilisateurs du forum appartient chaque membre. Votre site Web définit les règles et transmet les identifiants de groupe au forum, de sorte que l'accès d'un membre au forum corresponde toujours à son appartenance à votre site Web.
Comment ça marche
- Quels groupes attribuer. Votre site Web définit les bons groupes pour chaque membre et les transmet au forum.
- S'il faut démarrer l'authentification unique. Si les produits ou programmes des membres ont expiré, votre site Web ne les connecte tout simplement pas au forum.
Le forum ne lit jamais lui-même vos données de membre. Tout est piloté par votre site Web.
Avant de commencer
- Obtenez votre clé API. Vous en avez besoin pour chaque demande de cet article.
- Obtenez l'ID de chaque groupe d'utilisateurs que vous souhaitez attribuer, par exemple un groupe par programme.
Attribuer des groupes lors de la création d'un compte
Incluez le paramètre UserGroups dans votre demande de connexion à connexion unique. Si le compte n'existe pas encore, il est créé avec ces groupes.
Séparez les différents identifiants par des virgules. Ces groupes s'appliquent lors de la création du compte pour la première fois. Pour changer de groupe ultérieurement, utilisez les requêtes d'API de la section suivante.
Mettre à jour les groupes en cas de changement d'appartenance
Lorsqu'un membre achète, met à niveau ou perd un programme sur votre site Web, mettez à jour ses groupes de forum à l'aide de l'API Website Toolbox. Ces requêtes sont exécutées depuis votre serveur, vous pouvez donc les effectuer au moment où le changement se produit. Le membre n'a pas besoin d'être connecté.
Mettre à jour tous les groupes d'un membre en une seule demande
Pour apporter plusieurs modifications à la fois, par exemple ajouter un membre à deux groupes et le supprimer d'un seul, envoyez une demande au terminal du membre avec chaque groupe auquel il doit appartenir. Les groupes que vous envoyez remplacent les groupes actuels du membre. Incluez donc tous les groupes que vous souhaitez qu'ils conservent.
Pour voir les groupes actuels du membre avant de les remplacer, envoyez une requête GET à la même adresse.
La réponse inclut les groupes d'utilisateurs actuels du membre.
Ajouter ou supprimer un groupe
Lorsque vous n'avez besoin d'accorder ou de révoquer qu'un seul groupe, utilisez plutôt le point de terminaison du groupe afin de ne pas avoir à envoyer la liste complète.
USER_ID est l'identifiant utilisateur du forum du membre, que la demande de connexion renvoie lors de la création du compte. Vous pouvez transmettre des noms d'utilisateur ou des adresses e-mail au lieu de noms d'utilisateur. Une adresse e-mail pour une personne qui n'a pas de compte sur le forum mais qui lui envoie une invitation à rejoindre le groupe à la place.
Décider qui a accès
Votre site Web vérifie l'adhésion du membre avant de commencer l'authentification unique. S'ils ont toujours accès, connectez-les à l'aide du jeton, comme décrit dans Single Sign On - Token Based Authentication. Si leurs produits ont expiré, ne lancez pas l'authentification unique et ils ne seront pas connectés au forum.
Questions fréquemment posées
Dois-je mettre à jour les groupes des membres ou utiliser le point de terminaison du groupe ?
Envoyez la liste complète des groupes au terminal du membre lorsque vous modifiez plusieurs groupes à la fois. Utilisez le point de terminaison du groupe lorsque vous n'ajoutez ou supprimez qu'un seul groupe.
Quand dois-je mettre à jour les groupes d'utilisateurs d'un membre ?
Mettez à jour les groupes chaque fois que l'adhésion du membre change sur votre site Web, qu'il s'agisse d'un achat, d'un surclassement ou d'une expiration. Il n'est pas nécessaire d'attendre la prochaine connexion du membre.
Le membre doit-il être connecté pour que les groupes soient mis à jour ?
Non. La mise à jour est une demande d'API provenant de votre serveur. Elle fonctionne donc que le membre soit connecté ou non ou qu'il visite le forum.
Qu'est-ce que Curl ?
Curl est un outil de ligne de commande permettant d'envoyer des requêtes HTTP qui est inclus dans macOS, Linux et les versions récentes de Windows. C'est pourquoi les exemples de cet article sont écrits sous forme de commandes curl. Vous pouvez envoyer exactement les mêmes requêtes depuis n'importe quel langage de programmation à l'aide de ses outils HTTP standard, avec les mêmes paramètres dans chaque langage. Consultez la section Exemple de code pour effectuer une requête HTTP pour obtenir des exemples dans plusieurs langues.
Pourquoi une demande d'API échoue-t-elle ?
Vérifiez que la clé API correspond à la clé API de votre forum, que l'ID de groupe et l'ID utilisateur sont corrects et que le membre possède déjà un compte sur le forum.
Comment trouver l'identifiant d'un groupe d'utilisateurs ?
Consultez la section Récupération de l'identifiant d'un groupe d'utilisateurs.