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

« Previous Version 59 Next »

To call Fuse API endpoints you need to be authenticated. This is done by sending your authentication token in a header called Auth-Token with every API request. From v5.0 onwards, we’ve introduced rotating authentication tokens, which means that each authentication token expires and renews at regular intervals.

Note: If you are using an older version of Fuse’s API (v4.4 and below) you can use the authentication method mentioned above or you can choose to use the deprecated authentication method.

To obtain your authentication token, you must use the following API request:

POST /session

Request

URL: https://<instance_name>.fuseuniversal.com/api/v5.0/session

Request parameters

When using this request, you must include the following mandatory parameters in the request body:

  • login_name: This is your username or email address used to log in to your Fuse instance, assigned to you when your account was created (e.g. joe.bloggs or joe.blogs@email.com).

  • password: This is your password used to log in to your Fuse instance.

Example response

{
  "success": true,
  "role": "admin",
  "administerable_community_ids": [
    9,
    10,
    11
  ],
  "admin_group_permissions": [
    "compliance_reporting"
  ],
  "is_manager": true,
  "terms_and_conditions_accepted": true,
  "password_change_required": false,
  "terms_and_conditions": null,
  "password_requirements": null,
  "jwt_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJIb3RmaXgiLCJleHAiOjE3MzIxNDcxOTksImlhdCI6MTcyOTUwNTc3NiwiYXVkIjpudWxsLCJqdGkiOiIyOTQ5OS4xOTI4NTYifQ.qz_fLuuTvyUTveheP8bwLwnDBgw_KpjZTdMEUf2WSnY",
  "auth_tokens": {
    "jwt_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJIb3RmaXgiLCJleHAiOjE3MzIxNDcxOTksImlhdCI6MTcyOTUwNTc3NiwiYXVkIjpudWxsLCJqdGkiOiIyOTQ5OS4xOTI4NTYifQ.qz_fLuuTvyUTveheP8bwLwnDBgw_KpjZTdMEUf2WSnY",
    "user_authentication_token": {
      "authentication_token": "RVt-k4zQJRyMBx3L",
      "updated_at": 1728784853
    }
  }
}

For more information about the /session endpoint, please reference the API documentation section in the Admin Panel of your instance:

Screenshot 2024-10-21 at 11.07.23.png
  • No labels