Wenn Ihre Website Mitgliedschaften, Programme oder Produkte hat, können Sie entscheiden, zu welchen Forum-Benutzergruppen jedes Mitglied gehört. Ihre Website legt die Regeln fest und übergibt die Gruppen-IDs an das Forum, sodass der Forenzugriff eines Mitglieds immer mit seiner Mitgliedschaft auf Ihrer Website übereinstimmt.
So funktioniert es
- Welche Gruppen sollen zugewiesen werden. Ihre Website ermittelt die richtigen Gruppen für jedes Mitglied und leitet sie an das Forum weiter.
- Ob Single Sign-On gestartet werden soll. Wenn die Produkte oder Programme des Mitglieds abgelaufen sind, meldet Ihre Website es einfach nicht im Forum an.
Das Forum liest niemals deine Mitgliederdaten selbst. Alles wird von Ihrer Website gesteuert.
Bevor du anfängst
- Holen Sie sich Ihren API-Schlüssel. Sie benötigen ihn für jede Anfrage in diesem Artikel.
- Rufen Sie die ID jeder Benutzergruppe ab, die Sie zuweisen möchten, z. B. eine Gruppe pro Programm.
Weisen Sie Gruppen zu, wenn ein Konto erstellt wird
Nehmen Sie den UserGroups-Parameter in Ihre Single-Sign-On-Anmeldeanforderung auf. Wenn das Konto noch nicht existiert, wird es mit diesen Gruppen erstellt.
Trennen Sie mehrere IDs durch Kommas. Diese Gruppen gelten, wenn das Konto zum ersten Mal erstellt wird. Um die Gruppen später zu ändern, verwenden Sie die API-Anfragen im nächsten Abschnitt.
Aktualisieren Sie Gruppen, wenn sich die Mitgliedschaft ändert
Wenn ein Mitglied ein Programm auf deiner Website kauft, aktualisiert oder verliert, aktualisiere seine Forengruppen mit der Website Toolbox API. Diese Anfragen werden von Ihrem Server ausgeführt, sodass Sie sie in dem Moment stellen können, in dem die Änderung erfolgt. Das Mitglied muss nicht angemeldet sein.
Aktualisiere alle Gruppen eines Mitglieds in einer Anfrage
Um mehrere Änderungen gleichzeitig vorzunehmen, z. B. ein Mitglied zu zwei Gruppen hinzuzufügen und es aus einer Gruppe zu entfernen, senden Sie eine Anfrage an den Endpunkt des Mitglieds mit jeder Gruppe, zu der es gehören sollte. Die Gruppen, die du sendest, ersetzen die aktuellen Gruppen des Mitglieds. Füge also alle Gruppen hinzu, die das Mitglied behalten soll.
Um die aktuellen Gruppen des Mitglieds zu sehen, bevor Sie sie ersetzen, senden Sie eine GET-Anfrage an dieselbe Adresse.
Die Antwort beinhaltet die aktuellen UserGroups des Mitglieds.
Eine Gruppe hinzufügen oder entfernen
Wenn Sie nur einer einzelnen Gruppe die Genehmigung erteilen oder entziehen müssen, verwenden Sie stattdessen den Endpunkt der Gruppe, damit Sie nicht die gesamte Liste senden müssen.
USER_ID ist die Forum-Benutzer-ID des Mitglieds, die die Anmeldeanfrage zurückgibt, wenn das Konto erstellt wird. Sie können Benutzernamen oder E-Mail-Adressen anstelle von Benutzer-IDs übergeben. Eine E-Mail-Adresse für jemanden, der noch kein Forenkonto hat, sendet ihm stattdessen eine Einladung zur Gruppe.
Entscheiden, wer Zugriff erhält
Ihre Website überprüft die Mitgliedschaft des Mitglieds, bevor Sie mit der einmaligen Anmeldung beginnen. Wenn sie noch Zugriff haben, melden Sie sie mit dem Token an, wie unter Single Sign On — Tokenbasierte Authentifizierung beschrieben. Wenn ihre Produkte abgelaufen sind, starten Sie nicht mit Single Sign-On, dann werden sie nicht im Forum angemeldet.
Häufig gestellte Fragen
Sollte ich die Gruppen der Mitglieder aktualisieren oder den Endpunkt der Gruppe verwenden?
Senden Sie die vollständige Liste der Gruppen an den Endpunkt des Mitglieds, wenn Sie mehrere Gruppen gleichzeitig ändern. Verwenden Sie den Endpunkt der Gruppe, wenn Sie nur eine Gruppe hinzufügen oder entfernen.
Wann sollte ich die Benutzergruppen eines Mitglieds aktualisieren?
Aktualisieren Sie die Gruppen, wenn sich die Mitgliedschaft des Mitglieds auf Ihrer Website ändert, z. B. bei einem Kauf, einem Upgrade oder einem Ablaufdatum. Sie müssen nicht auf die nächste Anmeldung des Mitglieds warten.
Muss das Mitglied angemeldet sein, damit die Gruppen aktualisiert werden können?
Nein. Das Update ist eine API-Anfrage von Ihrem Server. Es funktioniert also unabhängig davon, ob das Mitglied angemeldet ist oder das Forum besucht.
Was ist Curl?
Curl ist ein Befehlszeilentool zum Senden von HTTP-Anfragen, das in macOS, Linux und neueren Versionen von Windows enthalten ist. Aus diesem Grund sind die Beispiele in diesem Artikel als curl-Befehle geschrieben. Mit den Standard-HTTP-Tools können Sie aus jeder Programmiersprache genau dieselben Anfragen senden, mit denselben Parametern in jeder Sprache. Beispiele in mehreren Sprachen finden Sie unter Beispielcode für eine HTTP-Anfrage.
Warum schlägt eine API-Anfrage fehl?
Überprüfe, ob der API-Schlüssel mit dem API-Schlüssel deines Forums übereinstimmt, ob die Gruppen-ID und Benutzer-ID korrekt sind und ob das Mitglied bereits ein Forumkonto hat.