What is API Product or API Product?

API Product is a product created by combining one or more APIs. These APIs can be combined and presented to end users as an interface by exchanging data from different sources or systems.

API Products facilitate the use and management of APIs, while helping developers develop their own applications or services by using different APIs together.

All API Products published in the API Developer Portal or in draft stage are managed from this screen.

The listing screen has two different views; chart and list.

The picture below shows the graphic view screen details:


The picture below shows the list view screen details:


Creating a New API Product

An API Product can be created from an API Proxy or API Proxy Group. There are three stages in this process; API Product Information, Visibility and Plan & Monetization.

API Product Information Panel

The picture below shows the API Product Information settings:


The fields used for API Product information configuration are shown in the table below.

Field

Description

Name

It is the name information that the API Product will appear on the Portal.

Image

It is the name information that the API Product will appear on the Portal.

Title

It is the description information containing the general purpose of the API Product that will appear on the Portal.

Categories

API Product may be included in a category. Thus, it can be filtered by category when searching on the Portal.

Responsible Unit

This is the field where the responsible unit that created the API Product is entered.

Access requests from applications

If this option is enabled, access requests from applications can directly subscribe to the API Product without requiring approval.

API Proxy/API Proxy Group

This is the section where API Proxy/API Proxy Group settings are made to be compatible with the API Product.

Documents

This is the section where extra documents such as training are managed to shara the API Product with users.

Description

The detailed information about the API product, which will be displayed on the Portal, is added in a dynamic HTML format for viewing on the Portal.
Visibility Panel 


  • Public: Anyone can view the API Product.
  • Only logged in Organizations: Anyone can view the API Product.
  • Authorizated Organizations: Only authorized organizations defined here can view the API Product.
Plan & Monetization Panel


API Product must maintain at least one plan&monetization for release. There are 4 different plans; Free, Subscription, Metered and Tiered.

  • Free Plan: If this plan is selected, the API Product can be consumed free of charge. Throttling and quota (quota) can be added.

    • The fields used for the Free plan configuration are shown in the table below.

      Field

      Description

      Enable Throttling

      On a per second/minute basis, the number of requests to the API in a given time can be limited.

      Enable Quota

      On a per hour/day/month basis, the number of requests to the API in a given time can be limited.

  • Subscription Plan: If this plan is selected, a monthly or annual payment plan is created. In case of excess consumption, a new charging or stopping method may be applied.

    • The fields used for subscription plan configuration are shown in the table below.

      Field

      Description

      Enable Throttling

      On a per second/minute basis, the number of requests to the API in a given time can be limited.

      Enable Quota

      On a per hour/day/month basis, the number of requests to the API in a given time can be limited.

      Volume-based Fee

      Adjustments made are applied monthly or annually.

      Currency

      Currency can be determined as Turkish lira, dollar, euro.

      Billing Period

      The billing period can be selected monthly (monthly) or annually (annually).

      Continue on Exceed

      		If the specified payment plan is exceeded, the option to continue using is selected. If it is not active, consumption is stopped when the specified demand volume is exceeded.

      Fee on Exceed

      		Charges are determined for uses after the payment plan is exceeded.
  • Metered Plan: If this plan is selected, per-request charges apply.

    • The fields used for metered plan configuration are shown in the table below.

      Field

      Description

      A Call Fee

      		The fee for a request is entered.

      Currency

      The currency can be set as Turkish Lira, Dollar, or Euro.

      Billing Period

      The billing period can be selected monthly (monthly) or annually (annually).

  • Tiered Plan: If this plan is selected, a tiered payment plan will be created. For example, the first 1-10 requests could be charged at 10 lira per request, 10-50 requests at 5 lira per request, 50-100 requests at 1 lira per request, and so on, with different charges applied to different ranges.

    • The fields used for tiered plan configuration are shown in the table below.

      Field

      Description

      Calls From

      The initial value of the layer is determined.

      Calls To

      The final value of the layer is determined.

      Fee

      The fee in the specified tier range is determined.

      Billing Type

      If the tier pricing is to be determined on the basis of the total tier, it is Volume-based, or if a fee will be charged for each request in the tier, Transaction-based is selected.

      Currency

      Currency can be determined as Turkish lira, dollar, euro.

      Billing Period

      The billing period can be selected monthly (monthly) or annually (annually).

      Continue on Exceed

      		If the specified payment plan is exceeded, the option to continue using is selected. If it is not active, consumption is stopped when the specified demand volume is exceeded.

      Fee on Exceed

      		Charges are determined for uses after the payment plan is exceeded.

Publishing API Product

There are 2 states that must be provided for the API Product to be published: It must have a plan and the API Proxy must have an Authentication Policy of the Security Manager type.

If these two conditions are met, the API Product is ready for publication in the Catalogue. To publish the API Product, the Publish button is pressed and the API Product starts to appear in the catalog.

After API Product is published, it can be unpublished without deleting this definition to prevent it from appearing only in the API Catalog.

Deleting API Product

To delete the API Product completely, go to the edit page of the relevant product. At the bottom of the page, there is the title Delete API Product.


To confirm that you want to delete the API Product, a check box opens where the name of the relevant product is requested. When the product name is written correctly and the Delete button is clicked, the product is completely deleted.

The picture below shows the checkbox that appears when the API Product Delete button is clicked: