Adding Client Instances
Client Instances work in conjunction with Applications. For B2C SaaS products, there may be only one instance whereas for B2B SaaS products, each customer instance can be treated as a separate Client Instance.
At least, one Client Instance is required in order to generate API Credentials. In order to create a Client Instance, please follow the steps below.
Click on Add Client Instance, from the Client Instances tab
In the popup screen, enter the Client Instance Name first and then choose the Application created in the previous screen that you would like to associate with the Client Instance.
The Client Instance ID is a unique identifier automatically generated but this can be modified if you prefer something easy to read.
Field | Type | Description |
|---|---|---|
Client Instance Name | String | Name of the Client Instance. This can be anything of your choice and is only used to identify the client instances enabled for your account Client Instance name cannot be changed once created |
Associated Application | List | The Application you would like to associate with the Client Instance. The Application should be created first in order to select in this screen |
Client Instance ID | String | A unique identifier automatically generated for each Client Instance |
Any Client Instance created will be added to the Client Instance list screen as shown below.
The Associated Application and Client Instance ID can be edited by clicking on the Pencil icon under Action column.
You can add multiple Client Instances as allowed by your plan limits. Please contact your administrator or write to us at [email protected] if you would like to know what your plan allows.
