Contents

Popular
 Contents

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 Apps prompt in the API Management Dashboard and follow the instructions below to add a product, add Clients and add Client Subscriptions respectively.


Figure 1: Apps prompt in API Dashboard

Adding a Product

  1. Click the Products tab, and click the Add  button to add a new product.
  2. Provide the desired Product ID in the New API Product pop-up window and click OK.
  3. Select the Product ID to navigate to the respective Product Configuration page.
  4. Configure the product as per your requirement and add the desired projects to this product using projects selection box at the bottom of this page. Click the  Edit button to see the sections:
    • Projects in Product: Lists the projects added in the Product.
    • Available projects: Lists the projects available to be added.
  5. Click the Save button present at the bottom of the screen to add the product.
Icon

Refer to the Products section to know more about the attributes present in the Products section.

Adding a Client

  1. Click the Clients tab and click the Add  button to add a new client.
  2. Provide the desired Client ID in the New Client pop-up window and click OK.
  3. Select the Client ID to navigate to the respective Client Configuration page.
  4. Configure the client details such as Client Name, Email and Status as per requirement.

  5. Add the desired attributes and corresponding values by clicking the Add  button and then adding values under the Attribute and Value columns respectively.

    Icon

    Use the Delete icon to remove an attribute.

  6. Click the Save button present at the bottom of the screen to add the client.

Icon

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

Adding a Client Subscription

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

  1. Click the Client Subscriptions tab and click the Add  button to add a new subscription.
  2. Provide the desired Client Subscription ID in the New Client Subscription pop-up window and click OK.
  3. Select the Client Subscription ID to navigate to the respective Client Subscription Configuration page.
  4. Configure the Client Subscription details as per requirement and click Save.
  5. Add the necessary products to the app.

    Icon

    Edit the properties in the Properties section.

  6. Click Save to add the Client Subscription.
Icon

As the Client Subscription gets saved after adding the attributes and saving (clicking Save button), the API generates an API Key which is essential for authorization of client requests. Please refer the next section to know how to generate the API Key.

Icon

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

Adaptavist ThemeBuilder EngineAtlassian Confluence