Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Overview
Fuse Platform provides the Fuse API, a Fuse’s RESTful API that provides the a Manage Users Endpoint to allow our endpoint, which allows customers to integrate their Fuse instance with their HRISor identity system.
Let’s refer This guide refers to the Fuse API Manage Users RESTful EndpointRESTFUL endpoint as the Manage Users Endpoint for simplicity.
Start
Usingusing the Manage Users
Endpointendpoint
Read Take note of the following information before using the Fuse’s API.
Communication
Our API use the standard HTTP Request Methods/Operations for communication:
GET
is used to lookup/retrieve user/s a users and details.POST
is for the creation of used to create new user(s).PUT
is employed used to edit/update an existing user(s).DELETE
is applied when disactivating used to deactivate user(s).
Info |
---|
The Fuse RESTFUL API supports JSON (JavaScript Object Notation). |
Authorisation
Each Fuse API request requires authorization; the API authorization authorisation. The API authorisation is currently associated with one or more defined Admin admin user account/(s) on your Fuse instance.
Note |
---|
Please ensure Ensure that these accounts have suitably complex and valid passwords. |
Info |
---|
Please read See the Authorisation page to understand how to obtain a valid authentication. |
Additional Information
API Wiki Documentation
Each Fuse instance will have has a Swagger-based API Wiki documentation that lists all our API’s. This is only available to Admin level users
only:
https://<instance_name>.fuseuniversal.com/site-admin/api_documentations
API Version
Tip |
---|
This documentation is based on the most recent API version 4.3. |
All Fuse API’s are versioned.
We urge customers to 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.3/manage/users
Note |
---|
Whilst we always try to maintain support for older API versions, this is not always possible and all newer functionality will only be . All new functionality is released as a new version. |
API Key Terms
Use this information to get context related to some API concepts/terms.