This section describes how to publish a virtual API (endpoint) to the webMethods Mediator.
Before publishing an API for consumption, you must do the following high-level steps:
Virtualize the API. For procedures, see Virtualizing an API.
Configure the key settings of the API. For procedures, see Configuring Your API Key Settings.
When publishing an API, keep the following points in mind:
You must be a registered user (i.e., Provider) in the CentraSite.
You must belong to either one of the following roles:
CentraSite Administrator
API Publisher
Runtime API Provider
However, an administrator can grant these permissions to other roles.
For more information about permissions, see the CentraSite online documentation section About Roles and Permissions in the document Users, Groups, Roles and Permissions.
If you are a registered user and accessing CentraSite using the logon credentials, to publish an API, you must have Full permission on the API. If your user account belongs to a role that has the “Manage Assets” permission for an organization, you automatically have permission to publish all APIs in that organization. Also, if you are the owner of an API, you can publish that particular API.
If you are a registered user and accessing CentraSite as a guest, to publish an API, you must at least have the instance-level Full permission on the API.
This action is not visible for the following conditions:
Unless you have a minimum of "Full" permission on the API.
If the API does not belong to the type "Service".
Unless the API has one or more virtual APIs.
If the API is under the control of an active lifecycle model (LCM), ensure that:
The API is in a "deployable" lifecycle state. If you are not certain of what the "deployable" lifecycle state is, consult your CentraSite administrator.
The API has 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 section Built-In Actions for Design/Change-Time Policies in the document Built-In Design/Change-Time Actions Reference.
You can publish the virtual APIs for consumption to one or more targets in either of the following ways:
If you want to publish using the... | Follow the steps described in... |
---|---|
Native API's Publish action | Publishing an API from Native API's Action Menu |
Native API's Virtualize wizard | Publishing an API from Native API's Virtualize Wizard |
Virtual API's Publish action | Publishing an API from Virtual API's Action Menu |
You use this procedure to publish a virtual API using the native API's
action.To publish an API for consumption
In CentraSite Business UI, display the details page of the API you want to expose for consumption. For procedures, see the section Viewing Details of an API.
On the API detail page, click Publish API dialog.
. This opens theChoose the alias you want to publish from the drop-down labeled Virtual Alias. (The list will contain the virtual aliases that are defined for the native API.)
Enable the checkbox next to the name of the target to publish the API. You can select multiple targets.
Enable the Expose to Consumers checkbox to allow unauthorized consumers (guests) to search and access the API.
The Expose to Consumers checkbox is visible only to those users who have "Full" permission on the particular API.
Click the
button.Or:
Else, if at any time you wish to terminate this operation, just click
the button.
A Publish Progress popup will display the progress state of publishing your API. Click .
If the publish process failed, identify and correct the error and then try publishing the virtual alias again.
You use this procedure to publish a virtual API using the native API's
action.To publish an API for consumption
In CentraSite Business UI, display the details page for the API that you want to expose for consumption. For procedures, see the section Viewing Details for an API.
On the API details page, click ) action.
This opens the Virtualize < > wizard.
If there are no existing virtual alias, go to panel 1 in the Virtualize < > wizard. Define a virtual alias as described in the section .
Choose the alias you want to publish from the drop-down labeled Virtual Alias. (The list will contain the virtual aliases that are defined for the native API.)
Enable the checkbox next to the name of the target to publish the API. You can select multiple targets.
Enable the Expose to Consumers checkbox to allow unauthorized consumers (guests) to search and access the API.
The Expose to Consumers checkbox is visible only to those users who have Full permission on this API.
Click the
button.Or:
Else, if at any time you wish to terminate this operation, just click
the button.
A Publish Progress popup will display the progress state of publishing your API. Click .
If the publish process failed, identify and correct the error and then try publishing the virtual alias again.
You use this procedure to publish a virtual API using the API's
action.To publish a virtual API for consumption
In CentraSite Business UI, display the details page of the virtual API you want to publish. For procedures, see the section Viewing the Details of a Virtual API.
On the virtual API detail page, click Publish API dialog.
. This opens theEnable the checkbox next to the name of the target to publish the API. You can select multiple targets.
Enable the Expose to Consumers checkbox to allow unauthorized consumers (guests) to search and access the virtual API.
The Expose to Consumers checkbox is visible only to those users who have "Full" permission on this API.
Click the
button.Or:
Else, if at any time you wish to terminate this operation, just click
the button.
A Publish Progress popup will display the progress state of publishing your virtual API. Click .
If the publish process failed, identify and correct the error and then try publishing the virtual alias again.