API
Authentication, X-CommunityId, errors, pagination, the /sdk.js SDK and every endpoint.
- API introductionThe Memberfy REST API: base address, format, headers and where to start integrating.
- AuthenticationHow to get a token with email and password, send it on every call, how long it lasts, the public routes, acting on behalf of another profile and how to set up a safe integration account.
- X-CommunityIdThe header that says which community each call happens in and in which community your role is checked. Why no route carries the community in the path, where to find the community id and the errors you get when you forget it.
- Creation orderWhat has to exist before each call, where each id comes from, the sequence of common flows and the errors that show up when a step is skipped.
- Responses and errorsThe envelope of every response, the errors array that always comes back, the HTTP status codes and what to do with each, validation and business messages, the language of messages and deleted items.
- PaginationHow lists are split into pages with page and limit, the pagination block in the response, how to walk through everything and how filters and pagination combine.
- JavaScript SDKThe client the API publishes at /sdk.js and /sdk.mjs, generated from the specification itself. How to load it in the browser and in Node, the methods by topic, how to pass parameters and body, error handling and the client options.
- API referenceEvery public API endpoint, grouped by topic, generated from the OpenAPI specification the API itself publishes.