Please connect from a desktop to activate our interactive interface

The “Plan of Usage” field specifies the type of subscription plan a user has selected for accessing our API. This field helps in managing and monitoring API usage based on the plan’s limitations and benefits. The available plans include:

  • Trial: This plan offers a limited-time access to our API, allowing users to explore its features and capabilities before committing to a subscription.
  • Limited Free: Ideal for users with minimal usage needs, this plan provides a restricted number of API calls per month at no cost.
  • Unlimited Free: For users who require more extensive access, this plan offers unlimited API calls without any charges, subject to fair usage policies.
  • Paid: Tailored for businesses and developers with high-demand needs, this plan provides premium access to our API with enhanced support and additional features.
  • Request to Subscribe: With this plan user needs to request to publishers for usage of API Product with their business needs and justification.

 

To add Plan of Usage to your product on Portal:

In Plan of Usage fieldset in offers field click on Add Plan of Usage button

plans

After adding plan of usage field you need to select plan according to your API product configuration and your needs. This field includes options like Trial, Limited Free, Unlimited Free, Paid, Request to Subscribe

plans

 

Trial Plan: - 

The Trial plan is perfect for users who want to evaluate our API before making a long-term commitment. This plan provides limited-time access (15 days), allowing users to explore the various functionalities and capabilities of the API. It helps users ensure that the API integrates well with their existing systems and workflows. Can have mocked data or non prod data.

trial

Limited Free Plan: - 

The Limited Free plan is designed for users who have minimal usage requirements. It offers a set number of API calls each month without any cost. By providing a limited but sufficient amount of free usage, it allows users to benefit from the API’s features while managing their usage within the provided limit

limited

Unlimited Free Plan: -

The Unlimited Free plan is designed to provide extensive and continuous access to our API without any charge. By offering unlimited API calls, It ensure that users can fully leverage the API’s capabilities for their applications. However, to maintain service quality and availability for all users, this plan is subject to fair usage policies.

unlimited free

 

 

Paid Plan: -

Paid plan is specifically designed to meet the needs of businesses and developers with high-demand requirements. This plan offers premium access to our API, ensuring that users receive the highest level of service and performance. Subscribers to the Paid plan benefit from enhanced support, which includes priority assistance and dedicated resources to help them maximize the API’s potential. 

paid

 

Request To Subscribe: -

Request to Subscribe plan is tailored for users who have unique requirements that are not met by our predefined plans. Whether they need specialized access, unique features, or particular usage limits. Consumers need to fill up form to get access to API.

request to sub

 

In Product Configuration you can set Credentials App Approval flow 

Approval Flow: - 

In the API credential approval flow streamlines the process of granting access to users. 

Automatic Approval the system automatically evaluates and approves credential requests based on predefined criteria.

Approval Required :- In the API credential approval flow involves a manual review process where each credential request is evaluated by an administrator or a designated team. 

approval flow

 

Credentials Validity: - 

The duration for which the API credentials remain active and usable. This period is defined when the credentials are issued and can vary based on the type of plan or the specific requirements of the user or organization.

cred

Data Availability: - Data Availability in API refers to the types of data that users can access through the API. This can include different environments and data sets, such as Mocked Data, Production Data, and Non-Production Data

Mocked Data: Simulated data for testing and development without exposing sensitive information.

Non-Production Data: Data from development, testing, and staging environments, often anonymized for safety.

Production Data: Real data used in live environments, crucial for real-time services and highly secured.

data

API Product: - It is a collection of API proxies that are bundled together to provide a specific set of functionalities or services. Select API Product that you have configured in apigee configuration so consumers can subscribe to product and use the APIs.

api product

 

Product Bundle and Rate plans: -
Product Bundle is a collection of API products grouped together to provide a comprehensive set of services

Rate plans define the pricing and usage limits for API products or bundles. 

In this fields you need to select Product Bundle for and rate plan configured in Apigee for this particular plan that you have selected. 

bundule

Limits to, Calls per, Duration: - This fields are for limited free plan in this you need to specify how many calls per given duration can be managed by API proxy set in the apigee. 

Eg. Limits to 1000 calls per 1 day

Limited calls

Price: - Only for paid plan you need to specify this field as a price for your api for consumers. Price is in $.
Terms and Conditions: - This are normal terms and conditions that how consumers credentials will get approved and other API details so consumers can be aware of it.

price



Plans Visible to Consumers.