Version 9.5 SP1
 —  Virtualizing APIs Using the CentraSite Business UI  —

Publishing an API for Consumption

This section describes how to publish a virtual API (endpoint) to the webMethods Mediator.


Prerequisites

Before publishing an API for consumption, you must do the following high-level steps:

  1. Virtualize the API. For procedures, see Virtualizing an API.

  2. Configure the key settings of the API. For procedures, see Configuring Your API Key Settings.

Top of page

General

When publishing an API, keep the following points in mind:

Top of page

Ways in Which You Can Publish an API

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

Top of page

Publish an API from Native API's Action Menu

You use this procedure to publish a virtual API using the native API's Publish action.

Start of instruction setTo publish an API for consumption

  1. 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.

  2. On the API detail page, click Publish. This opens the Publish API dialog.

  3. 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.)

  4. Enable the checkbox next to the name of the target to publish the API. You can select multiple targets.

  5. 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.

  6. Click the Publish button.

    Or:
    Else, if at any time you wish to terminate this operation, just click the Cancel button.

  7. A Publish Progress popup will display the progress state of publishing your API. Click Ok.

    If the publish process failed, identify and correct the error and then try publishing the virtual alias again.

Top of page

Publish an API from Native API's Virtualize Wizard

You use this procedure to publish a virtual API using the native API's Virtualize action.

Start of instruction setTo publish an API for consumption

  1. 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.

  2. On the API details page, click Virtualize (graphics/virtualize.png) action. This opens the Virtualize < > wizard.

  3. If there are no existing virtual alias, go to panel 1 in the Virtualize < > wizard. Define a virtual alias as described in the section .

  4. 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.)

  5. Enable the checkbox next to the name of the target to publish the API. You can select multiple targets.

  6. 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.

  7. Click the Publish button.

    Or:
    Else, if at any time you wish to terminate this operation, just click the Cancel button.

  8. A Publish Progress popup will display the progress state of publishing your API. Click Ok.

    If the publish process failed, identify and correct the error and then try publishing the virtual alias again.

Top of page

Publish an API from Virtual API's Action Menu

You use this procedure to publish a virtual API using the API's Publish action.

Start of instruction setTo publish a virtual API for consumption

  1. 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.

  2. On the virtual API detail page, click Publish. This opens the Publish API dialog.

  3. Enable the checkbox next to the name of the target to publish the API. You can select multiple targets.

  4. 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.

  5. Click the Publish button.

    Or:
    Else, if at any time you wish to terminate this operation, just click the Cancel button.

  6. A Publish Progress popup will display the progress state of publishing your virtual API. Click Ok.

    If the publish process failed, identify and correct the error and then try publishing the virtual alias again.

Top of page