Configuring the Publish to API-Portal Policy
Perform the following steps to configure the Publish to API-Portal action in the Publish to API-Portal policy. This policy (1) creates a new API and (2) updates an existing API metadata in the API-Portal registry:
To configure the publish to API-Portal policy
1. Open CentraSite Control.
2. Go to Policies > Design/Change Time to display the policy list.
3. Enable the Show Predefined Policies option to display the predefined policies that CentraSite provides.
4. Click the Publish to API-Portal policy. This opens the Design/Change-Time Policy Details page.
5. If the policy is active, deactivate it. You cannot configure an active policy. If you need procedures for this step, see the CentraSite User’s Guide.
6. In the Actions tab, click the Publish to API-Portal action. Open the Edit Action Parameters page, and then do the following.
a. Set the following parameters:
API-Portal | Optional. String Array. The name of the API-Portal to which the API would be published. This assumes that you have already registered the API-Portal in CentraSite, as described in the document Working with the CentraSite Business UI. Note: | However, if this action is to be executed in a different event other than OnTrigger, for example, Pre-State Change or Post-State Change, that is not provided by default, you must specify a value for this field. |
|
Endpoint Category | Optional. String. Array. The names of specific taxonomy categories by which the base URLs (endpoints) of the API are classified. |
REST Service Attributes | Optional. String. Array. A metadata bundle can be supplied with additional information of a RESTful API and published to an API-Portal gateway. You use this field to specify additional attributes of the REST API to be published to the API-Portal gateway. |
SOAP Service Attributes | Optional. String. Array. A metadata bundle can be supplied with additional information of a SOAP-based API and published to an API-Portal gateway. You use this field to specify additional attributes of the SOAP API to be published to the API-Portal gateway. |
The event scope of this action is:
Pre-State Change
Post-State Change
OnTrigger
b. Click Save to save the parameter settings.
7. After you configure the parameters for all of the actions in the list, click Save to save the updated policy.
8. When you are ready to put the policy into effect, activate it as described in the CentraSite User’s Guide.
