Mitglieder-API
Wie das Backend eines Frontends vom Studio etwas über Mitgliedschaften erfährt.
Über die Mitglieder-API erfährt ein Frontend mehr über Mitgliedschaften, als das Zugriffstoken sagt. Jeder Aufruf kommt aus dem eigenen Backend des Frontends und trägt dessen Frontend-Schlüssel.
| Endpunkt | Fragt | Braucht |
|---|---|---|
POST /api/v1/members/eligibility | Ist ein Antragsteller, der nicht angemeldet sein muss, ein berechtigtes Mitglied meiner Community? | Frontend-Schlüssel, die IP-Adresse des Antragstellers |
GET /api/v1/members/me | Welche Mitgliedschaft hat der angemeldete Frontend-Benutzer, mit seinen Mitgliedsdaten? | Frontend-Schlüssel und das Zugriffstoken des Benutzers; nur interne Frontends |
Basis-URL und Authentifizierung
Das Studio stellt die Mitglieder-API unter <studio>/api/v1 bereit. Senden Sie den Frontend-Schlüssel als Bearer-Token:
Authorization: Bearer ofk_<Präfix>_<Geheimnis>
Der Schlüssel bestimmt die Organisation und das Frontend und damit die Community, für die eine Frage beantwortet wird. Siehe Frontend-Schlüssel.
Nur von Server zu Server
Es gibt kein CORS: Ein Browser kann die Mitglieder-API nicht aufrufen. Rufen Sie sie aus Ihrem Backend auf und geben Sie an den Browser nur weiter, was Ihre Seite braucht.
Die Antwort nennt nie den Grund
Die Mitglieder-API antwortet mit einem Status, nie mit dem Grund dahinter. Eine unbekannte Mitgliedsnummer und eine bekannte mit anderen Angaben erhalten dieselbe Antwort, ebenso die vielen Gründe, aus denen eine Mitgliedschaft nicht gültig sein kann. Die Studio-Benutzer der Organisation sehen die Gründe im Prüfprotokoll; Ihr Frontend nicht, es kann sie also auch nicht preisgeben.
In diesem Abschnitt
- Berechtigung aus einem Backend: nach einem Antragsteller fragen, vor oder ohne Anmeldung.
- Das angemeldete Mitglied: die Mitgliedschaft und die Mitgliedsdaten des angemeldeten Benutzers lesen, etwa um ein Formular vorauszufüllen.
- Ergebnisse, Ratenlimits und Fehler: jeder Status und jeder Fehler, und die Limits dahinter.
- Die Referenz: Ist ein Antragsteller ein berechtigtes Mitglied? und Die Mitgliedschaft des angemeldeten Frontend-Benutzers, erzeugt aus der OpenAPI-Beschreibung.