Publishing and Unpublishing an API to API-Portal
The publishing process of an API is carried out by a synchronous mechanism between the CentraSite, Mediator and API-Portal.
The API publishing process is initiated from CentraSite and is carried out by the “API-Portal Publish Service” on API-Portal. Doing this involves the following high-level steps:
Step 1: An administrator initiates the publish process by selecting the APIs that are to be published and specifies to which (registered)
API-Portals they are to be published.
Step 2: The
CentraSite API Publish Service on
CentraSite prepares the selected APIs for publishing (preparation includes bundling the API metadata information as a zip package) and invokes the
API-Portal Publish Service on the
API-Portal. The prepared zip package is submitted as input to this service.
Step 3: The
API-Portal Publish Service parses the zip package content and publishes the bundled APIs in the
API-Portal.
Step 4: If the publish is successful, the
API-Portal Publish Service returns a success message and data that is pertinent to the published APIs. If the publish is unsuccessful, the
API-Portal Publish Service returns a failure message.
Step 5: The
CentraSite API Publish Service on
CentraSite logs information about the publishing progress in the Publish log. If the
API-Portal Publish Service returned specific data about the API, the API's metadata is updated as needed in the registry/repository.
The following procedure describes how to publish and unpublish API to API-Portals.
