Publishing REST API Descriptors to API Portal

You can publish REST API descriptors created on Integration Server to webMethods API Portal. API Portal is a web-based portal that allows organizations to securely expose different types of APIs to external users. You must use Designer to connect to API Portal, and publish the REST API descriptors.

You can select one or more REST API descriptors in Designer for publishing to API Portal. You can update the details of an already published descriptor on API Portal. However, you cannot retract an already published descriptor. Instead, you can delete the published descriptors from API Portal, if required.

Before you can publish REST API descriptors to API Portal, you must define a connection configuration in Designer. For information about working with connection configurations for API Portal, see Connecting to webMethods API Portal for Publishing REST API Descriptors.

1. In the Package Navigator view of Designer, right-click the REST API descriptor you want to publish and select Publish.

If you want to publish multiple REST API descriptors in a folder or a package, right-click the particular folder or package and select Publish.

Note:

If you want to update details of a REST API descriptor that is already published to API Portal, you can select the particular descriptor for publishing. In such a situation, Integration Server overwrites the existing details for that descriptor on API Portal.

2. In the Asset Publish dialog box, select API-Portal as the destination for publishing the descriptors and click Next.

The Publish Assets to API-Portal dialog box lists the API descriptor you selected in Step 1. If you selected a folder or a package, all the descriptors in the particular folder or package are selected in the dialog box.

3. In the Publish Assets to API-Portal dialog box, refine your selection of API descriptors by selecting or clearing the appropriate check boxes, and click Finish.

The publish process starts for the REST API descriptors that you selected. Designer displays the results of the publish process for the selected descriptors on the Published Metadata screen.

Note:

For information about the errors that occur during the publish process, see the Integration Server server log.