Publishing and Unpublishing Services to and from API Portal Gateway

CentraSite allows you to publish and unpublish services to and from webMethods API Portal gateway.

To publish and unpublish services to and from an API Portal gateway, you must have the following roles or permissions:

CentraSite Administrator

Organization Administrator

API Portal Publisher

Instance-level Modify permission for API Portal gateway

If you have the CentraSite Administrator role, you can publish and unpublish services to and from API Portal gateways within any organization.

If you have the Organization Administrator role or API Portal Publisher role for an organization, you have the ability to publish and unpublish services to and from the API Portal gateways within the specific organization.

Publishing a Service to API Portal gateway refers to the process you use to deploy native and virtual services to API Portal on which they are to be exposed for testing and user consumption.

The process of publishing a Service to the API Portal gateway is initiated from CentraSite and is carried out on the API Portal server.

Doing this involves the following high-level steps:

1. A user initiates the publish process by selecting the virtual services that are to be published, and specifies in which API Portals they are to be published.

2. CentraSite publishes the virtual services to each of the specified API Portals.

3. The publishing process continues even if CentraSite encounters a failure with one of the API Portal.

4. CentraSite logs information about the Services that fail at the end of the publish process. If the process of publishing returned specific data about the Service, its metadata is updated as required in the API Portal registry.

The following section describes some aspects of runtime you need to consider when you publish and unpublish services to API Portal gateways:

You can only publish virtual services to the API Portal gateway for which you have the required roles or the Modify instance-level permission.

In addition to publishing virtual services, you can publish a native service to API Portal gateway.

When publishing a virtual service to both API Portal and Mediator gateways in a single step, only if publishing to at least one Mediator gateway was successful, CentraSite will publish the service to API Portal.

When trying to publish a service to a set of gateways, if the service is already published to a selected gateway, then that service is republished to that particular gateway.

When unpublishing a service from the API Portal gateway, the access tokens associated with the unpublished service are revoked from the API Portal registry. These revoked access tokens will continue to reside in the CentraSite's repository.

When republishing a service (which is already unpublished) to the API Portal gateway, the access tokens associated with the service and which already exist in the CentraSite's repository are once again published to the API Portal registry.