Contents

Popular

A group of projects can be gathered and made available for your clients by adding them to a product. This product will later be associated with a subscription to client(s), which is secured by an API Consumer Key.

Icon

This section gives you descriptions of the properties available in the Products section. Refer Adding Products, Clients and Client Subscriptions section for a step by step instruction on how to add a product.

In the New API Product dialog box that appears on clicking the Add  button, provide a name in the Product ID text field present.


Figure 1: Dialog box to add product with a product ID

Provide the following details under the Configuration tab to configure the product.


Figure 2: Product Configuration attributes

AttributeDescription
Product nameProvide a name for the product that helps to identify the behavior of the product.
DescriptionProvide a brief description of the product.
Server Groups

Choose the Server Groups from the options in the drop-down.

Icon

Please refer Creating a Server Group for Project Deployments section in the Quick Start page to know how to add Environment.

AccessSelect Private or Public depending on whom to provide access. The products which are marked to be publicly accessible will be made available for subscription in Developer portal.
Key Approval

Key Approval can be made automatic or manual.

  • Automatic: In case of automatic approval, subscription keys will be generated instantly when a developer subscribes to a product from Developer portal.
  • Manual: With Manual approval, the keys will be available in portal only after they are explicitly permitted from the client subscription by API administrator. Refer the Managing Key Approval section under Client Subscriptions / Applications page to know how to do this.
QuotaProvide the values to set a limit of requests that can be processed for the product. Provide a number and select the minute/hour/day/month from the drop-down

Click the Edit  icon (see the figure above) present at the right side of the Projects in Product section below to add projects to the new product. Select the required project from the Available Projects section that appears on the right side and click the left arrow to move the project to the Projects in Product section.


Figure 3: Editor to add existing projects to the product

Icon

Use CTRL/SHIFT to select more projects and them click the left arrow to move them all at once.

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

By this, the new product gets added with the choice of project(s) and the preferred environment(s).

Icon
  • After saving the product, 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 product altogether, select the product under the Products tab in the left navigation panel and click Remove button.
Adaptavist ThemeBuilder EngineAtlassian Confluence