After adding a client, a Client Subscription needs to be added, which helps in generating the API consumer key for the client to access the respective products.
Tip |
---|
Refer to the Adding Products, Clients and Client Subscriptions section for a step by step instructioninstructions to add Client Subscriptions. |
Click the Add button to open the New Client Subscription dialog box. In the Client Subscription ID field, provide a name for the Client subscription so that the API can set access for the client internally.
Figure 1: Option to add a Client Subscription with an ID
Now provide Provide the following required details under the Configuration tab and click Save button to apply the changes.
...
Attribute | Description | ||
---|---|---|---|
App ID | The name that you add provided while creating the client subscription gets auto-populated. | ||
App Name | Provide a name for client subscription by which you can to identify the subscription. | ||
Client ID | Select the client ID from the drop-down list. Client ID provided in the Client Configuration will be is available here. | ||
Status | Provide the status of the client subscription from the options as below, as per requirement:
| ||
API Products | Add the required products from the Available Products section.
| ||
Properties | In case there is a requirement to To add additional properties, click the Add ![]() | ||
Description | Describes Describe about the subscription for future reference. |
Click Click the Save button to apply the changes after adding product(s) in the subscription (clicking Cancel at this point discards click the Cancel button to discard the changes).
By thisWith the above steps performed, the new Client Subscription gets added with to the choice of product(s).
Info |
---|
|
Generating API Key
Note |
---|
After saving the details above details, refer to the Generating API Key section to know how to generate API Key for the respective client subscription of the product. |
...
When a product whose key approval is marked as Manual (if Key Approval Type property of Figure 2 in Products page is selected as 'Manual') is added to a client subscription, the corresponding keys will not be available for the developers instantlyimmediately. To So, to approve the keys in such cases, the administrator has needs to modify the corresponding application which will be is present as a client subscription.
In the Client Subscription Configuration page, click the product name which has the Manual type Key Approval and select the Approve check box, that which appears along with the Consumer Key that gets generated in order to complete , for key approval after which the keys will be visible to the developer.
...