Contents

Popular

A group of projects can be gathered and made available for 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.

This section illustrates how to add a product, how to add a project to a product and also gives descriptions of the properties available in the Products section.

Creating a Product

Adding a new product

  1. Click the Products  tab and select the respective Server Group from the drop-down.



  2. Click the Add  icon and provide a name in the Product ID text field.

  3. Click OK to add the product.


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

    The product configuration screen gets displayed (refer to the next section).

    Icon

    After configuring values and after adding project(s) to a product, click the Save icon on the upper-right part of the screen to save the product.

    Icon

    The name of the product turns green after it is saved.

Adding Product Configuration

Provide the required details under the Product Configuration tab.


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 Server Groups from the options in the drop-down list.

Icon

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

AccessSelect the Private or Public option depending on the nature of access required. The products which are made publicly accessible will be made available for subscription in the Developer portal.
Key Approval

The 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 the Developer portal.
  • Manual: With Manual approval, the keys are available in the portal only after they are explicitly permitted by the API administrator via client subscription. Refer to the Managing Key Approval section under Client Subscriptions / Applications page to do this.
QuotaProvide the values that 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 list.
Scope

Comma-separated scopes which are used while generating OAuth Access Token for the product.

Example

Icon

READ,WRITE,DELETE,GET,POST

Adding Projects to a product

To add projects to a product,

  1. Click the Edit  icon (see the figure above) in the Projects in Product tab in the API Projects property to add projects to the product.
  2. Select the required project from the Add/Remove Projects tab that replaces the Add/Remove Projects tab for the time being.
  3. Click the Tick  mark in the Add/Remove Projects tab to add products.


    Figure 3: Editor to add existing projects to the product

  4. Click the Save button to apply the changes after adding project(s) to a product.
Icon

To discard the changes before saving, click the Reset  icon next to the Save icon.

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

Saving and Removing products and More options

Save

Ensure clicking the Save  icon after configuring a policy so that the policy gets saved in the server.

Click Save all  icon under the Policies section to save all the policies listed.

Using the policy in a project

Icon
  • After adding the policies, it can be used by the projects from the Policies screen in the respective project.
  • After saving the product, to edit the properties of the product, make the required changes in the configuration panel and then click Save again.

Remove

The Remove  icon in the individual policy configuration screen deletes the selected policy. 

Icon

To remove a product that is already added to a Client Subscription, it has to be removed from the subscription first.

The Remove multiple  icon under the Policies section allows deleting more than one policy.

Select the products and click the Delete button.

Icon

Enable Select products checkbox to select all products.

Icon

A product can be deleted only if it is not subscribed and if it is not used in any organization.

More options

This option helps to copy, move, import, and export products present in the selected Server Group. Refresh option helps to clear unsaved changes in products.

Select the Server Group from which the operation has to be performed, click the More options button and select the respective option to perform the operation. 

Copy

Helps to copy the products saved in a particular Server Group to other Server Groups. Multiple products can be selected and can be copied to multiple Server Groups by using the corresponding checkboxes.

Steps
  1. In the chosen Server Group, click the More Options button and click the Copy option (see the figure above).
  2. In the Copy to server group drop-down, select the server groups to which the products need to be copied.

  3. Select the products that need to be copied.

    Icon

    The Copy button gets enabled upon selecting a product.

    Icon

    Enable Select products checkbox to select all products.

  4. Click the Copy button to copy all the selected product(s) to the selected Server Groups.

    Icon

    If a product already exists in that Server Group, it cannot be copied; to overwrite an already existing product, enable the Overwrite if product already exists option while copying.

Move

Helps to move the products saved in a particular Server Group to other Server Groups. Multiple products can be selected and can be moved to multiple Server Groups by using the corresponding checkboxes.

Steps
  1. In the chosen Server Group, click the More Options button and click the Move option.
  2. In the Move to server group drop-down, select the server groups to which the products need to be moved.

  3. Select the products that need to be moved.

    Icon

    The Move button gets enabled upon selecting a product.

    Icon

    Enable Select products checkbox to select all products.

  4. Click the Move button to move all the selected product(s) to the selected Server Groups.

    Icon

    If a product already exists in that Server Group, it cannot be moved; to overwrite an already existing product, enable the Overwrite if product already exists option while moving.

Import

Helps to import product(s) saved in a particular location to the Products list in the chosen Server Group.

Steps
  1. In the chosen Server Group, click the More Options button and click the Import option.

  2. Click the Choose a json file to import products button to browse the json file containing product(s) to be imported.

    Icon

    If any error occurs on parsing or if the content is not readable/altered or the file is chosen wrong, it will show the error.

  3. After the product(s) gets added to the list of products under the Select products to Import section, the Import option gets enabled.



    If a product already exists in that environment, it cannot be imported.
    1. To overwrite an already existing product, enable the Overwrite if exists option

    2. Provide a different name under the Rename column to customize the product.


      Icon

      Clicking the Cancel button cancels the operation and goes back to the Products page.


  4. Click the Import button to import the product(s) to the selected server group; the imported product gets added to the Products list.


Export

Helps to download products that are saved in the selected Server Group.

Steps
  1. In the chosen Server Group, click the More Options button and click the Export option.

  2. Select the products that need to be exported/downloaded.

    Icon

    Enable Select products checkbox to select all products.

    Icon

    The Export button gets enabled upon selecting a product.

  3. Click the Export button to download the selected product(s) as a JSON file.

Refresh

On clicking the Refresh option, a confirmation dialog appears to refresh the products table, which wipes out all the changes which are not saved in the server.

Monetization

Helps to configure product rate-plans and to add a transaction recording policy.

Transaction Recording Policy

To know how to add a policy, refer to the Adding a Transaction Recording Policy section.

Rate Plan

To know how to add a policy, refer to the Adding Product rate plans section.

Freemium Package

The extent of the free period. Select one of the following radio buttons:

  • By Quantity: The free period is based on a quantity specified in the Volume field.
  • By Duration: The free period is based on a time interval specified in the Freemium Duration field.
  • Whichever comes first: The free period ends when either the quantity in the Volume field or the time interval in the Freemium Duration field is reached, whichever happens first.
  • No: This is not a Freemium plan. This is the default.

Freemium Volume

The volume of transactions (or volume pertaining to a custom attribute recorded in the transaction recording policy) for which developers are charged. The volume is measured across all products in the API package. Enter a volume number, such as 5000. This means that when developers start the plan, they are not charged for the first 5000 transactions (or for the first 5000 uses of a custom attribute-related item). This field is enabled only if you select "By Quantity" or "Whichever comes first" in the "Freemium Package?" field.

Freemium Duration

The time interval during which developers are not charged. Enter a number and select a time period, for example, 1 Month. This means that developers are not charged for 1 month following the start date of the purchased plan. This field is enabled only if you select "By Duration" or "Whichever comes first" in the "freemium Package?" field.

Icon

Refer to the Setting up Monetization section to know how to configure monetization.

Click the Import button to import the product(s) to the selected server group.

Adaptavist ThemeBuilder EngineAtlassian Confluence