Version 9.6
 —  Virtualizing APIs Using the CentraSite Business UI  —

Publishing an API Proxy

This section describes how to publish a proxy API to the webMethods Mediator.

To publish a proxy API, the following prerequisites must be met:

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.

Publishing a Single Proxy API

You use this procedure to publish a single proxy API using its Publish action.

Start of instruction setTo publish a single proxy API

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

  2. On the API detail page, click Publish graphics/publish.png. This opens the Publish API dialog.

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

  4. In the Advanced Settings node, select the Expose to Consumers checkbox. This allows unauthorized consumers (guests) to search and access the proxy API.

  5. Click Publish.

    Or:
    If at any time you wish to terminate this operation, click Cancel.

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

Publishing a Set of Proxy APIs

You use this procedure to publish a set of proxy APIs using the native API's Virtualize or Publish action.

Start of instruction setTo publish a set of proxy APIs

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

  2. On the API details page, click the Virtualize graphics/virtualize.png action. Go to panel 3 of the Virtualize wizard.

    Or:
    Click the Publish graphics/publish.png action. This opens the Publish API dialog.

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

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

  5. In the Advanced Settings node, select the Expose to Consumers checkbox. This allows unauthorized consumers (guests) to search and access the proxy APIs.

  6. Click Publish.

    Or:
    If at any time you wish to terminate this operation, click Cancel.

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

Top of page