Cloud operating system for your business

Most of Omnibasis APIs are secured with accessToken and user role.  

Read Token Based Authentication to learn how to obtain accessToken.

User roles can be configured under omniCustomers \ Roles

Once we have accessToken, we can use it to call any authorized actions. All Omnibasis APIs  are available to be used remotely. For example, we can use the User service to get a list of users:

Step 1: Configure location link and method

Use POST method and API call below.  

Use this link to access via API explorer:

https://api.omnibasis.com/explorer/index.html?urls.primaryName=Omnibasis%20User%20Shared%20API

https://api.omnibasis.com/users/User/GetUsers

Step 2: Configure default call headers

TIP: User presets to create header shortcuts. 

Step 3: Configure call body

You can use this sample body:

{
  "filter": "",
  "status": 1,
  "permission": "",
  "role": null,
  "permissionId": "",
  "consentId": "",
  "loyaltyProgramId": "",
  "loyaltyLevelId": "",
  "organizationUnitId": null,
  "organizationUnitIds": [],
  "preferenceAudienceId": "",
  "preferenceAudienceIds": [],
  "excludeOrganizationUnitId": null,
  "excludePreferenceAudienceId": "",
  "onlyLockedUsers": false,
  "sorting": "id",
  "maxResultCount": 1000,
  "skipCount": 0
}

Step 4: Complete call

In our example we sent a POST request to https://api.omnibasis.com/users/User/GetUsers with added Authorization to the header as "Bearer <accessToken>" and Body with filters. 

Returning JSON contains the list of users.

Note: You can explore and test all Omnibasis API with Omnibasis API Explorer.