Contents

Popular

After adding a client, a Client Subscription needs to be added, which helps in generating API consumer key for the client to access the respective products.

Icon

Refer Adding Products, Clients and Client Subscriptions section for a step by step instruction.

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 API can set access for the client internally.


Figure 1: Option to add a Client Subscription with an ID

Now provide the following details under the Configuration tab and click Save button to apply the changes.


Figure 2: Client Subscription Configuration attributes

AttributeDescription
App IDThe name that you add while creating the client subscription gets auto populated.
App NameProvide a name for client subscription by which you can identify the subscription.
Client IDSelect the client ID from the drop-down. Client ID provided in the Client Configuration will be available here.
Status

Provide the status of the client subscription from the options as below, as per requirement:

  • Active: Activates the subscription for the client.
  • Pending: Keeps the subscription in hold. This can be used during a waiting period while you wait for any data.
  • Revoked: Closed state were the subscription will not be available for the client.
API Products

Add the required products from the Available Products section.

Icon

Click the Edit  button and then select and move the products using the left arrow  button.


Figure 3: Editor to add existing products to the subscription

PropertiesIn case there is a requirement to add additional properties, click the Add  button corresponding to Properties section and then add the name and the corresponding value.
DescriptionDescribe about the subscription for future reference.

Click Save button to apply the changes after adding product(s) in the subscription (clicking Cancel at this point discards the changes).

By this, the new Client Subscription gets added with the choice of product(s).

Icon
  • After saving the client subscription, if you want to edit the properties of the product, just make the respective changes in the configuration panel and then click Save again.
  • To remove a subscription altogether, select the subscription name under the Client Subscriptions tab in the left navigation panel and click Remove button.

Generating API Key

Icon

After saving the above details, refer the Generating API Key section to know how to generate API Key for the respective client subscription of the product.

Managing Key Approval

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 instantly. To approve the keys in such cases, the administrator has to modify the corresponding application which will be 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 appears along with the Consumer Key that gets generated in order to complete key approval after which the keys will be visible to the developer.


Figure 4: Approve option to approve Product Key manually

Adaptavist ThemeBuilder EngineAtlassian Confluence