Usage Cases for Publishing an API
When deciding where to publish an API, consider the following scenarios:
Scenario 1: Publish a simple API to API-Portal. In this scenario you simply publish a plain API (that is, API instances of the asset type, Service, REST Service, XML Service) to the
API-Portal. You may want this scenario to allow clients of the
API-Portal to simply access and examine the usage of an API.
Scenario 2: Publish a virtual API to Mediator. In this scenario you add additional policy enforcement definitions (during virtualization) on top of the simple API, configure authentication settings for the virtual API, and later publish the virtual API to the
Mediator. You may want this scenario to allow restricted clients of the Integration Server to access and use the API, upon acquiring the valid client access tokens through
CentraSite.
Scenario 3: Publish a virtual API to API-Portal. In this scenario you add additional policy enforcement definitions (during virtualization) on top of the simple API, configure authentication settings for the virtual API, and later publish the virtual API to the
Mediator and
API-Portal. You may want this scenario to allow restricted clients of the
API-Portal to access and use the API, upon acquiring the valid client access tokens through
API-Portal.
