Overview
Our Developer API covers the following areas of functionality.
If you have a need for API access to anything that isn't covered, please reach out to your Customer Success Manager to discuss your requirements.
Structure and User Management
Your users are central to any Reelyze implementation. Our Developer API allows you to automate user management, along with your organisation structure to ensure users have the correct level of access to content.
Structure
Within your Reelyze tenant, your users are organised in a hierarchy, which for best results should mirror your organisation structure.
All users belong to an organisation, and are placed into the heirarchy based on their department.
The heirarchy might look something like the following:
Code
Each of the departments in the above example would have a number of users associated with it.
Organisations
Organisations are the top-level entity within your structure. In the vast majority of cases, a single Organisation is sufficient.
Your default (root) organisation is created automatically for you.
Use of multiple organisations is an enterprise feature, and is disabled by default. If you require access to create multiple organisations, please contact us to discuss your requirements.
Departments
Each Organisation contains a number of Departments, organised in a tree. A root department is created for you automatically. You can add departments below this point to model the structure of your business - for example broken down by region and store / location, or head office department.
You can manage Departments using our Developer API, see here for details.
User Management
Our Developer API offers endpoints for managing the users within your organisation.
Details of the user endpoints can be found here