Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Overview

Fuse Platform provides the Fuse API, a RESTful API that provides the Manage Users Endpoint to allow our customers to integrate their Fuse instance with their HRIS or identity system.

Let’s refer to the Fuse API Manage Users RESTful Endpoint as the Manage Users Endpoint for simplicity.

Start Using the Manage Users Endpoint

Read the following information before using the API.

Communication

Our API use the standard HTTP Request Methods/Operations for communication:

  • GET is used to lookup/retrieve user/s and details.

  • POST is for the creation of new user(s).

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

  • DELETE is applied when disactivating user(s).

Fuse API supports JSON (JavaScript Object Notation).

Authorisation

Each Fuse API request requires authorization; the API authorization is currently associated with one or more defined Admin user account/s on your instance.

Please ensure that these accounts have suitably complex and valid passwords.

Please read the Authorisation page to understand how to obtain a valid authentication.

Additional Information

API Wiki Documentation

  • Each Fuse instance will have a Swagger-based API Wiki that lists all our API’s.

    • This is available to Admin level users only: https://<instance_name>.fuseuniversal.com/site-admin/api_documentations

API Version

This documentation is based on the most recent API version 4.3.

  • All Fuse API’s are versioned.

    • We urge customers to 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

Whilst we always try to maintain support for older API versions this is not always possible and all newer functionality will only be released as a new version.

API Key Terms

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

  • No labels