API
Authentifizierung, X-CommunityId, Fehler, Paginierung, das SDK /sdk.js und jeder Endpoint.
- Einführung in die APIDie REST-API von Memberfy: Adresse, Format, Header und wo du mit der Integration anfängst.
- AuthentifizierungWie du mit E-Mail und Passwort einen Token bekommst, ihn bei jedem Aufruf mitschickst, wie lange er gilt, die öffentlichen Routen, das Handeln im Namen eines anderen Profils und wie du ein sicheres Integrationskonto einrichtest.
- X-CommunityIdDer Header, der festlegt, in welcher Community jeder Aufruf stattfindet und in welcher deine Rolle geprüft wird. Warum keine Route die Community im Pfad trägt, wo du die Community-ID findest und welche Fehler kommen, wenn er fehlt.
- Reihenfolge beim AnlegenWas vor jedem Aufruf existieren muss, woher jede ID kommt, die Abfolge der gängigen Abläufe und die Fehler, die erscheinen, wenn ein Schritt übersprungen wird.
- Antworten und FehlerDer Umschlag jeder Antwort, das errors-Array, das immer mitkommt, die HTTP-Codes und was bei jedem zu tun ist, Validierungs- und Geschäftsmeldungen, die Sprache der Meldungen und entfernte Elemente.
- PaginierungWie Listen mit page und limit in Seiten aufgeteilt werden, der Block pagination in der Antwort, wie du alles durchläufst und wie Filter und Paginierung zusammenspielen.
- JavaScript-SDKDer Client, den die API unter /sdk.js und /sdk.mjs veröffentlicht, erzeugt aus der Spezifikation selbst. Wie du ihn im Browser und in Node lädst, die Methoden nach Thema, wie du Parameter und Body übergibst, die Fehlerbehandlung und die Client-Optionen.
- API-ReferenzJeder öffentliche Endpoint der API, nach Thema gruppiert, erzeugt aus der OpenAPI-Spezifikation, die die API selbst veröffentlicht.