Create API Products and Plans

Last updated: Jan 31, 2025

Tyk Enterprise Developer Portal

If you are interested in getting access contact us at [email protected]

Introduction

There are two ways of creating API Products and Plans in the Developer Portal:

Automatically create an API Product or Plan in the Developer Portal by importing it from Tyk when synchronising the provider.
Manually create an API Product or Plan in the Developer Portal. (Only from version 1.13.0)

Prerequisites

A Tyk Self-Managed installation.
Tyk Self-Managed added as a provider.
Have APIs created in your Tyk installation.

Import API Product and Plan

When integrating with Tyk, the Tyk policies will be imported into the Developer Portal. Depending on the configuration that’s been set in the policy section, the policy will either be imported as an API Product or a Plan. For further details check the portal key concepts document.

Create and import an API Product from Tyk

API Products are partitioned policies that provide an ACL but not quota/rate limits. The following steps explain how to create and import an API product from Tyk, assuming you have one or more APIs already created:

From your Tyk Self-Managed installation, go to Policies and click Add policy.
Select which APIs you want to add to your API product.
From the Access Rights drop-down list, select one or more APIs to include in your policy.
Under Global limits and Quota, select Enforce access rights. Ensure Enforce usage quota and Enforce rate limit are not selected.
From the Configurations tab, add the information needed under name and settings.
From the Tags tab, a tag can be added to tell the portal this should be imported. If you have specified a specific label in the Provider section within the Developer portal when adding Tyk, the way the portal would know which Policies to import can be specified here.
To import the API Products into the Developer portal, from the Tyk Portal admin app, click Synchronise.

Create and import plans from Tyk

Plans are policies that implement rate limit or quota, or both, but do NOT include the ACL. To create a Plan for the developer portal, follow the same steps as for creating an API Product. However, within the Global limits and quota in the Policies, configure the policy as follows:

From your Tyk Self-Managed installation, go to Policies and click Add policy.
Select an API. Please note that this a required field. The purpose of the policy explained in this guide is to control allowance, so you can select any API here.
Under Global limits and Quota, select Enforce usage quota and Enforce rate limit. Ensure Disable rate-limiting and Unlimited requests are not selected so you can set these limits.
Click Synchronise to import the plans into the Developer portal, from the Tyk Portal admin app.

Manually Create API Product and Plan

From version 1.13.0, the Developer Portal allows you to create API Products and Plans from the portal dashboard for admins. When manually creating an API Product or Plan, the corresponding policy will be created in the Tyk Self-Managed selected provider.

Create API Product

When creating an API Product in the Developer Portal, a partitioned policy that provides an ACL but not quota/rate limits will be created in the Tyk Self-Managed selected provider. The following steps explain how to create an API Product in the Developer Portal:

From the Tyk Portal admin app, go to API Products and click Add new API Product.
Select a unique name for the API Product and complete the product details for customization in the Details tab. The product name will be the name assigned to the created policy in the Tyk Self-Managed selected provider
Select Provider, Authentication, and APIS in the API’s tab.
Add API specifications in the Documentation tab.
Add Product Guides in the “Getting Started” guides tab.
Complete DCR settings in the Dynamic Client Registration tab (Only for JWT selected APIs).
Save changes.

Note:

If no APIs are selected, you can still add api specifications, and guides creating a documentation only product. Documentation only products are Developer Portal products that do not have any APIs associated with them and thus no policies will be created in the Tyk Self-Managed selected provider. Documentation only products are useful for creating documentation for APIs that are not yet created or published. Specs and guides will be shown in the external portal as a regular product and the selected Specification Alias will be used as the reference for each spec.

Add a Documentation only Product

Create Plan

When creating a Plan in the Developer Portal, a partitioned policy that implements rate limit or quota, or both, but do NOT include the ACL will be created in the Tyk Self-Managed selected provider. The following steps explain how to create a Plan in the Developer Portal:

From the Tyk Portal admin app, go to Plans and click Add new Plan.
Choose a Provider and a unique Name for the plan. The plan name will be the name assigned to the created policy in the Tyk Self-Managed selected provider.
Complete Plan limits. Select Usage quota, Rate limit, and Key expiration for the plan.
Complete Advanced settings (optional). Set Scopes (for DCR), Access Request Frequency, and Credential metadata for the plan.
Save changes.