User signup flow in the API
In this guide we'll cover how you can replicate the standard member signup flow through the User API.
This flow is useful if you're building an application that uses the OfficeRnD API to sign up members and you don't intend to use the standard members portal signup flow.
Normally in the OfficeRnD admin UI you'd first create a member and then invite them by "enabling" their access.
Alternatively you'd just rely on members to sign up through the signup page.
In contrast in the User API you need to first create a user with credentials and then associate them with a member.
Step 1 - Creating a user
The first step of the flow is to create a user.
This is done by using the /signup endpoint of the User API:
After you've created the user, you should be able authenticate to the API with the user credentials.
Step 2 - Authenticating to the User API
In order to associate a member with the newly created user we'll need to generate an OAuth 2.0 token which we can use as authentication.
This can be achieved by using the /auth/signin endpoint:
If the request is successful the response body should contain the OAuth 2.0 token you can use as authentication for the final step.
Step 3 - Creating a member
In order to associate a member with the created user we'll need to use the token we generated in the previous step.
We'll be using the /subscribe endpoint in order to create the member:
After the request is successful, the member should appear in the admin UI of OfficeRnD in the "Community" section. They should also be "enabled", as they have an active user with credentials that grants them access to your members portal.
Important
Disabling a member's access in the admin UI will delete the user associated with the member, but the member will remain.
The only way to once again associate a user with the member is to invite them through the admin UI.
Updated over 1 year ago