This section includes:
...
Overview
Fuse’s RESTful API provides includes a Manage Users endpoint, which allows customers to integrate their Fuse instance with their a HRISor identity system.
This guide refers to the Fuse ‘Fuse API Manage Users RESTFUL endpoint endpoint’as the Manage ‘Manage Users Endpoint endpoint'for simplicity.
Using the Manage Users endpoint
Take note of the following information before using the Fuse’s API. Manage Users endpoint:
Communication
The Fuse API uses standard HTTPrequest method/operations.
These are as follows:
Request method |
|---|
...
Description | |
|---|---|
| Allows you to retrieve a user and their details. |
|
...
Allows you to create a new user |
...
. |
|
...
Allows you to edit |
...
and update existing |
...
users. |
|
...
Allows you to deactivate users. |
| Info |
|---|
...
Fuse’s RESTFUL API supports JSON (Java Script Object Notation). |
Authorisation
Each Fuse API request requires authorisation. The API authorisation is currently associated with one or more defined admin user account(s) accounts on your Fuse instance.
| Note |
|---|
Ensure that these accounts have suitably complex and valid passwords. |
| Info |
|---|
See the Authorisation page for how to obtain a valid authentication. |
Additional information
API Documentation
Each Fuse instance includes Swagger-based API documentation that lists all the Fuse API endpoints. This is only available to Fuse Admins with access to the Admin panel: https://<instance_name>.fuseuniversal.com/site-admin/api_documentations
API Version
| Tip |
|---|
This documentation is based on the most recent API version 4.34. |
All Fuse APIs are versioned. It is recommended that customers always use the latest API version available.
The API version is shown within the endpoint URL for example:https://<instance_name>.fuseuniversal.com/api/v4.34/manage/users
| Note |
|---|
Whilst Fuse always tries to maintain support for older API versions, this is not always possible. All new functionality is released as a new version. |
API key terms
Throughout this guide you will see several API related terms To familiarise yourself with these terms, see API key terms.