Publish APIs

As an Anypoint API Community Manager community administrator, you can add and publish APIs, API groups, and minor and major updates from Anypoint Exchange into your Salesforce Experience Cloud site.

This information includes the API documentation stored with the APIs in Exchange. The API documentation is separate from the articles stored in the Salesforce content management system (CMS). The API release process includes API documentation updates, and the CMS article release process is usually separate. Often a development team will lead the API release process and a marketing team will lead the CMS article release process.

Add APIs or API Groups from Exchange to Your Site

  1. Open the API Community Manager control panel and select Manage APIs.

    From this tab, you can manage the APIs and API groups in your site, including their metadata and visibility.

    • APIs in this Community shows the APIs and API groups that have been added to the community.

    • APIs in Exchange shows the APIs and API groups that exist in your Exchange organization but have not been added to the community.

  2. Next to the API or API group name, click Add to Community.

  3. Set the API or API group information, including visibility, name, icon, and description.

Set API or API Group Information

The API or API Group editing page opens when you add an API or API Group to the site.

To open the editing page again, next to the API or API Group name, click Edit.

  1. Optionally, edit the API Name.

  2. Select Replace Icon to set the API or API Group icon.

  3. Enter a Description for the API or API Group.

  4. Leave the Visibility of all versions as Administrators only, or set visibility for some versions to None, while you preview the API or API Group as described in the next section.

  5. Optionally, add a link to more information on the API or API Group.

    When your API or API Group is displayed on the community site in the API Carousel component or in an API card, by default it has a single API Details button. It can also have an optional Learn more button that links to a business content page. In the Associated "Learn-more" Page section, select None to keep the default, or select Custom page and set the Custom page URL to a business content page created in Community Builder.

  6. Select Apply.

Preview APIs

  1. In the API Community Manager control panel, click Community Builder.

    Community Builder displays a preview of your community’s site and edit options.

  2. Select Preview.

  3. Scroll to the API carousel that displays a card for each API or API Group version in the community.

The new API version or API Group shows the message This is only visible for you, indicating Administrators only visibility. Consumer developers cannot see this API version or API Group preview.

If no changes are visible, refresh the cache.

Make API Versions Visible

  1. In the API Community Manager control panel, click Manage APIs.

  2. Click Edit next to the API or API Group name.

  3. For each version, set Visibility to Everyone if you want it to be publicly available, Members only if you want it to be seen only by logged-in members, or None if you do not want that version to be visible.

    At least one version must be visible by having an option other than None.

  4. Select Apply.

Consumer developers can now see this API or API Group in the API carousel on the community site.

On the Manage APIs tab, the Visibility column shows the visibility of the most visible version of that API or API Group.

Minor API Updates

When an API specification or documentation requires nonbreaking corrections, such as changing the text, these changes are given a minor version change, such as from 3.0.0 to 3.0.1. API Community Manager automatically and immediately imports these updates to all communities in which the API is published, without requiring any action from the API Community Manager administrator.

For example, suppose both the text in an API’s documentation and the text in the API Specification description have spelling errors.

To make corrections in the API specification:

  1. Open the Design Center.

  2. Open the API project and fix the errors.

  3. Select Publish to Exchange.

  4. In the Publish API specification to Exchange dialog box, leave the existing Name, Main file, and API Version, but increment the Asset version for a non-breaking change. For example, change 3.0.0 to 3.0.1.

  5. Select Publish.

To make corrections in the API documentation:

  1. Open Exchange.

  2. Open the API.

  3. Select Edit and fix the errors.

  4. Select Save as draft.

  5. Select Publish.

Consumer developers see the corrected information on the community site immediately.

If no changes are visible, refresh the cache.

Major API Updates

When a new version of the API with breaking changes is created, the API Community Manager community administrator controls when and how to publish the new version in the site, mark the old version as deprecated, and remove the old version.

For example, suppose a developer on the API team adds a new resource to an API.

  1. In Design Center, the developer opens the API project, adds the resource to the specification, and selects Publish to Exchange.

  2. Because this is a breaking change, the developer changes the API version information in Publish API specification to Exchange.

    For example, if the API version is v3, it becomes v4. If the Asset version is 3.0.1, it becomes 4.0.0. Name and Main file do not change.

  3. The developer selects Publish.

    The previous API version remains in all communities where it was published without any changes.

The API Community Manager community administrator must then review and publish the changes:

  1. In the API Community Manager control panel, select Manage APIs.

    The API is still listed in APIs in this Community. The new version has visibility None.

  2. Next to the API, click Edit.

  3. Change the visibility to Administrators only.

  4. Preview the API.

  5. In the API Community Manager control panel, select Manage APIs.

  6. Next to the API, click Edit.

  7. Change the visibility of the new version from Administrators only to Everyone if you want it to be publicly available, Members only if you want it to be seen only by logged-in members, or None if you do not want that version to be visible.

    If the visibility is Everyone or Members only, then consumer developers can now see the new API version in the API carousel on the community site.

If no changes are visible, refresh the cache.

Searching for APIs and API Groups

In the API Community Manager control panel, the Manage APIs tab shows a Search APIs field.

The tab shows a maximum of 100 results, followed by a message if additional results were omitted. Use the search field to filter the APIs so that no relevant API is omitted.

Enter one or more terms into the search field. Search results are listed in APIs in This Community and APIs in Exchange.

You can filter search results with the following filter attributes:

  • name

  • version

  • description

  • businessGroup

  • assetType (api or group)

To use a filter attribute, type the attribute name followed by a colon and the value for that attribute. For example: filtering with name:order only shows APIs with names that include "order", such as "Order Status API" or "Received Orders".

Search terms without a filter attribute only apply to API fields that are not filtered. For example, the search businessGroup:Sales banking shows APIs that include "Sales" in the "Business Group" field and "banking" in any field other than "Business Group".

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub