This section describes how to publish a proxy API to the webMethods Mediator.
To publish a proxy API, the following prerequisites must be met:
Before you publish a proxy API to the webmethods Mediator, you must configure the consumption settings for that particular API. For procedures, see Configuring the API Consumption Settings.
You must be a registered user in the CentraSite.
You must belong to either one of the following roles:
"CentraSite Administrator"
"API Publisher"
For more information about roles, see the CentraSite online documentation section Users, Groups, Roles and Permissions > About Roles and Permissions .
You must have at least the instance-level Full permission on the proxy API.
webMethods Mediator must be configured and running on the webMethods Integration Server.
To expose a proxy API for consumption, make sure that the " Set API Publish Permissions" policy is active. If the policy is in the inactive state, you must activate it. By default, this policy is active.
The "Set API Publish Permissions" policy includes a "Set Permissions" action that grants the instance-level "View" permission for the proxy API to the users in "Everyone" group. In addition, you can use the option "Propagate permissions to dependent objects". For more information, see the description of the action in the online documentation section Built-In Design/Change-Time Actions Reference > Built-In Actions for Design/Change-Time Policies .
The Publish action is not visible in the details page for a proxy API, unless the following conditions are satisfied:
Proxy API should be one of the following asset types: Virtual Service, Virtual XML Service, Virtual REST Service.
If the proxy API is under the control of an active lifecycle model (LCM), ensure that:
Proxy API is in a "deployable" lifecycle state. If you are not certain of what the "deployable" lifecycle state is, consult your CentraSite administrator.
Proxy API is associated with a design-time policy that includes the "Change Deployment Status" action and it is set to Yes. This action specifies whether the API is eligible for deployment. For more information, see the description of the action in the online documentation section Built-In Design/Change-Time Actions Reference > Built-In Actions for Design/Change-Time Policies .
You can publish a single proxy API or a selected set of proxy APIs. The descriptions in this section give you details on how to do this.
You use this procedure to publish a single proxy API using its
action.To publish a single proxy API
Display the details page for the proxy API that you want to publish to webMethods Mediator. For procedures, see the section Viewing Details for an API Proxy.
On the API detail page, click Publish API dialog.
. This opens theFrom the Available Targets list, choose one or more targets in which you want to publish the proxy API.
Or:
If you want to publish the proxy API across all the targets, select the All Targets checkbox.
When attempting to publish a proxy API, without selecting at least on target, a warning popup box appears.
In the Advanced Settings node, select the Expose to Consumers checkbox. This allows unauthorized consumers (guests) to search and access the proxy API.
Click
.Or:
If at any time you wish to terminate this operation, click .
A Publish Progress popup will display the progress state of publishing the proxy API to the webMethods Mediator.
If the publish process failed, identify and correct the error and then try publishing the proxy API again.
You use this procedure to publish a set of proxy APIs using the native API's
or action.To publish a set of proxy APIs
Display the details page for the native API whose proxy endpoints (APIs) you want to publish to webMethods Mediator. For procedures, see the section Viewing Details for an API.
On the API details page, click the Virtualize wizard.
action. Go to panel 3 of theOr:
Click the action.
This opens the Publish API dialog.
Choose the proxy APIs you want to publish from the drop-down labeled Virtual Alias. (The list will contain the proxy APIs that are defined for that particular API.)
From the Available Targets list, choose one or more targets in which you want to publish the proxy APIs.
Or:
If you want to publish the proxy APIs across all the targets, select the All Targets checkbox.
When attempting to publish the proxy APIs, without selecting at least on target, a warning popup box appears.
In the Advanced Settings node, select the Expose to Consumers checkbox. This allows unauthorized consumers (guests) to search and access the proxy APIs.
Click
.Or:
If at any time you wish to terminate this operation, click .
A Publish Progress popup will display the progress state of publishing the proxy APIs to the webMethods Mediator.
If the publish process failed, identify and correct the error and then try publishing the proxy APIs again.