Adding Products, Clients and Client Subscriptions

After creating the project, add the project (or projects in case more than one is added) to a product so that products can be used by the clients by adding the API Key based Subscription provided.

Click the Applications tab in the API Management Dashboard and follow the instructions below to add a product, add Clients and add Client Subscriptions respectively.

Adding a Product

1. Click the Products tab on the left side of the Applications page, and click the Add icon on the upper-left part of the page to add a new product.

2. Provide the desired Product ID in the dialog box and click OK.

3. Select the Product ID to navigate to the respective Product Configuration page.

   

   For a new product, it opens for editing by default after adding.

4. Configure the product as per your requirement by providing details such as Product Name and Server Group.

5. Add the desired attributes and corresponding values by clicking the Add icon in the Attributes section and then add values under the Attribute and Value columns respectively.

6. Click the Edit icon in the API Projects property in the configuration to add the desired projects.

7. Select the project that needs to be added to the project.

8. Click the Save icon present at the bottom of the screen to add the product.

Use the Delete icon to remove an attribute

Refer to the Products section to know the relevance of a product and the attributes present in the Products screen.

Adding a Client

1. Click the Clients tab on the left side of the Applications page and click the Add icon on the upper-left part of the page to add a new client.

2. In the dialog box, provide a valied email id as the Client ID and click OK.

3. Select the Client ID to navigate to the respective Client Configuration page.

   

   For a new client, it opens for editing by default after adding.

4. Configure the client details such as Client Name, Email id and Status as per requirement.

5. Add the desired attributes and corresponding values by clicking the Add icon in the Attributes section and then add values under the Attribute and Value columns respectively.

6. Click the Save icon present on the upper-right part of the page to add the client.

   

   Under the Client column on the left side, the client ID appears in red font color until it is saved. After saving, it turns green.

Use the Delete icon to remove an attribute

Refer Clients section to know more about the attributes present in the Clients Section.

Adding a Client Subscription

Client Subscription is a combination of a single client and multiple products. To add a Client Subscription, perform the following actions:

1. Click the Client Subscriptions tab on the left side of the Applications page and click the Add icon on the upper-left part of the page to add a new subscription.

2. In the dialog box, provide the desired Client Subscription ID and select the desired Client ID (from the ones added in the Clients section above) from the drop-down and click OK.

3. Select the Client Subscription ID to navigate to the respective Client Subscription Configuration page.

   

   For a new client subscription, it opens for editing by default after adding.

4. Configure the Client Subscription details by providing details such as App Name and product; add the necessary products to the app by clicking the Subscribed Products Edit button.

5. Click the Save button on the upper-right part of the Applications page to add the Client Subscription.

   

   Under the Client Subscriptions, the client ID appears in red font color until it is saved. After saving, it turns green.

   

   After adding a product, ensure clicking the Save icon to generate the API Key which is essential for authorization of client requests gets generated. Please refer to the next section to know how to generate the API Key.

Refer to the Client Subscriptions / Applications section to know more about the attributes present in the Client Subscriptions Section.