Publishing an Individual API from the Native API Details Page
When you execute a publish action from the native API details page, the exact rendering of user interface depends on whether or not the native API has an immediate virtualized API.
If the native API does not have an immediate virtualized API, you will be allowed to directly publish the native API to
API-Portal gateway.
If the native API has an immediate virtualized API, you will directed to choose the virtualized APIs, and then publish them to both gateways.
Perform these steps to publish an individual API from the details page of a native API.
To publish a single API using details page of native API
1. In CentraSite Business UI, display a list of available APIs.
2. In the displayed list, click the name of the native API.
3. In the action bar of the native API, click Publish.
4. If the displayed native API does not have an immediate virtualized API, CentraSite directs you to the Publish to Gateway dialog box.
5. Moreover, if the displayed native API has a virtualized API, you will have an intermediate Publish Virtual APIs dialog box. This dialog box allows you to configure the virtualized API for publishing to the gateways.
The Publish Virtual APIs dialog box lists the names of all of its virtualized APIs.
a. Mark the checkbox of each virtualized API you want to publish to the gateways.
b. Click Next. This opens the Publish to Gateway dialog box.
6. In the Gateway drop-down box, choose the gateway to that you want to publish the API.
The gateways displayed in the drop-down box are the gateways for that you have the Modify permission.
The gateways list includes the following:
If you choose... | CentraSite will display... |
Mediator | Instances of the Mediator gateway. |
API-Portal | Instances of the API-Portal gateway. |
All Gateways | All instances of both the Mediator and API-Portal gateways |
By default, the Gateway drop-down box is set to All Gateways.
7. If you want to further restrict the list of gateways, you can filter the gateways based on the sandbox by which they were classified.
When you filter gateways using a sandbox, CentraSite displays gateways whose endpoints are classified by the specified sandbox. For example, you could use a Production sandbox to filter the gateways whose endpoints were classified using the Production sandbox.
In the Sandbox drop-down box, choose the category by which the gateways were classified.
Note that apart from the predefined categories, you can also use your custom categories to filter the gateways. The predefined categories include:
If you choose... | CentraSite will display... |
Development | Instances of a specified gateway whose endpoints were classified by the Development category. |
Production | Instances of a specified gateway whose endpoints were classified by the Production category. |
Test | Instances of a specified gateway whose endpoints were classified by the Test category. |
All Sandboxes | Instances of a specified gateway whose endpoints were classified by any of the above mentioned categories. |
By default, the Sandbox drop-down box is set to All Sandboxes.
8. The gateways list provides the following information about each gateway:
Column | Description |
Name | The name assigned to the gateway. |
Type | The type of gateway. |
Sandbox | The category that classifies deployment endpoint of the gateway. |
Settings | The Configure icon displays the API-Portal Settings dialog box that enables you to configure a set of sandbox categories for the specified API-Portal individually. The dialog box also lists the set of API communities available for the specified API-Portal. You can assign an API to one or more API communities. |
9. Mark the checkbox of each gateway to which you want to publish the API.
10. Optional. Applicable for an API-Portal. Select the sandbox category that classifies the endpoint of the API for publishing to API-Portal, and assign the API to one or more communities available for the specified API-Portal. Do the following:
a. Click the Configure icon next to Sandbox field.
This icon displays the API-Portal Settings dialog box.
b. Select the sandbox categories.
c. Select one or more communities from the list. By default, the API is assigned to the Public Community. Any new communities assigned will overwrite the existing assignments.
d. Click OK.
For more information on API communities, see webMethods API-Portal Administrator’s Guide.
11. Optional. Applicable for a Mediator. Enable the Expose to Consumers option to allow guest users to simply access and examine the usage of API through CentraSite.
12. When you have finished making your settings, click Publish.
13. A Publish Inprogress popup will display the progress state of publishing the API to selected gateways.
If the publish process logs failures, identify and correct the failure and then try publishing the API again.
