Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

Fuse’s RESTful API provides a Manage Users endpoint, which allows customers to integrate their Fuse instance with their HRISor identity system.

This guide refers to the Fuse API Manage Users RESTFUL endpoint as the Manage Users Endpoint for simplicity.

Start using

Using the Manage Users endpoint

Take note of the following information before using the Fuse’s API.

Communication

Our The Fuse API use the uses standard HTTPRequest Methods/Operations for communicationrequest method/operations:

  • GET is used to lookup/retrieve a users user and their details.

  • POST is used to create new user(s).

  • PUT is used to edit/update existing user(s).

  • DELETE is used to deactivate a user(s).

Info

The Fuse RESTFUL API supports JSON (JavaScript Object NotationJava 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) on your Fuse instance.

Note

Ensure that these accounts have suitably complex and valid passwords.

Info

See the Authorisation page to understand for how to obtain a valid authentication.

Additional

Information

information

API Wiki Documentation

Each Fuse instance

has a

includes Swagger-based API documentation that lists all

our API’s

the Fuse API endpoints. This is only available to Fuse Admins with access to the Admin

level users

panel: 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

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.3/manage/users

Note

Whilst we Fuse always try tries to maintain support for older API versions, this is not always possible. All new functionality is released as a new version.

API Key Termskey terms

  • Use this information to get context related to some API concepts/terms.