Managing Organisational Units using the Assure Customer API
An Overview of how to use the Assure Customer API to Manage Organisational Units
The Assure Customer API can be used to automate the processes of managing Organisational Units in Assure. The API is accessed via the internet as a secure RESTful API which is widely supported by integration platforms, ETL tools and all programming and scripting languages, so it can be easily set up to integrate with external systems. Making use of the Customer API requires a level of technical expertise so this is typically something that a company’s IT function would handle.
The API functionality must be enabled by the Evotix Support Team before you can use it. Please contact your CDM (Customer Development Manager) or CSM (Customer Success Manager) should you be interested in procuring this feature.
HOW DOES IT WORK?
With the Customer API you can:
-
Create new Organisational Units
-
Update existing Organisational Units
-
Deactivate Organisational Units
Each of these operations requires you to make a request to the Customer API. A detailed user guide and supporting API schema will be provided detailing the API methods and the information required to use them.
WHAT DETAILS HAVE TO BE PROVIDED?
The minimum required fields are:
-
Name
-
External Organisation Unit identifier - requires External IDs to be setup for your Organisation Units
-
Parent External Organisational Unit identifier - requires External IDs to be setup for your Organisation Units
Other fields that can be set and will be defaulted if not supplied:
-
Default Users
-
Module Overrides
-
Additional defined module fields
OUT OF SCOPE
The following elements are currently out of scope:
-
Adding branding to the Organisational Units. This includes report images and banner images
SETTING UP THE API
- Before you can get started you need to request access from Evotix through your Customer Development or Customer Success Manager.
- You can create and manage your API authentication keys at any time in Assure. Check out this article for details (API Key Management Article).
- Set up the Customer API. Access the user guide here (Customer API User Guide 1 – Getting Started).
- Set up the API to manage Organisational Unit Structure. Access the user guide here (Customer API User Guide 3 – API for Org Unit Structure).