Managing API Entitlements
An entitlement is the relationship between an API and a plan. Review the topics to manage API entitlements.
Understanding API Entitlements
An entitlement is the relationship between an API and a Plan that defines how a client application can access the API.
There is a many-to-many relationship between plans and APIs. A given plan can have entitlements to multiple APIs; for example, to group related APIs. A given API can be entitled by multiple plans; for example, to provide different quality of service criteria. Note that two entitlements of the same plan cannot point to the same entire API, or to the same action in an API.
-
Keep API open: The API does not require plans nor applications.
-
Unmanaged: A plan is not required, but the client needs to create an application to access API.
-
Managed: The API is entitled to one or more plans, and the client must create an application and subscribe that application to one of the plans.
Viewing API Entitlement Details
You can view the entitlements that are added to the API and other details such as whether the entitlement is active or inactive and whether it is published or unpublished.
Adding an Entitlement to an API
You can add an entitlement to an API from the API component.
Publishing and Unpublishing an Entitlement in an API
You must publish an entitlement in an API to enable the application developer to access it from Developer Portal.
Activating and Deactivating an Entitlement in an API
You must activate the entitlement in an API for the application developer to access it from developer portal.
Removing an Entitlement from an API
You can remove an entitlement from the API that is not required.
- On the APIs List page, click the API from which you want to remove an entitlement.
- Click the (Entitlements) tab.
- Click the name of the entitlement you want to remove.
- Click the Remove button.
- Click Yes.