Contact Free trial Login

Description of API Community Manager Lightning Components

You design the pages of your Anypoint API Community Manager portal by adding and configuring Lightning components in Community Builder.

These Lightning components include both the Lightning components available in all Salesforce Communities, and the API Community Manager Lightning components available only in API Community Manager.

Each API Community Manager Lightning component has different configuration options and adds different functionality to the portal.

Many API Community Manager Lightning components show data from Anypoint Platform. Community admins can change some of these data fields, such as API names, descriptions, and icons. API Community Manager saves these changes but does not push the changes back to Anypoint Platform.

The Anypoint API Community Manager Search Box component enables users to search for both content that exists in Community Cloud (such as knowledge articles, support cases, and announcements) and content that exists in Anypoint Platform (such as APIs and client applications). Results from the search are presented in the ACM Search Results component.

You can specify values for the following parameters of the API Community Manager Search Box:

Component Title

Specifies the title for the search input field.

Number of Results - Instant Incremental Response

Specifies the number of results shown as the user types a query.

Search Areas

Selects which types of content to search. Choices include APIs, Applications, Knowledge Articles, Cases, Pages, and Forums.

Linked Result Page

Specifies the URL of the search results page shown after the user enters a search.

The Linked Result Page parameter specifies the URL of a search results page, and the search results page must include an ACM Search Results component to display the search results. If the page does not include an ACM Search Results component, members and guest users who enter a search will go to the page and see no results.

If a content type is not selected in the Search Areas parameter, then the linked ACM Search Results component omits results of that content type.

Your community’s default pages have one ACM Search Box and one ACM Search Results component, and this is the best practice to minimize the chance of misconfigurations, although it is possible to use separate searches for separate audiences within your community’s members.

The search does not include CMS articles in the search results.

Search results are sorted by the date they were most recently modified, from newest to oldest.

To test and preview the search configuration and the presentation of the results page, preview your API community and run a search.

ACM Search Results

The API Community Manager Search Results component shows results after a user enters a search in the ACM Search Box component.

You can specify values for the following parameters of the Search Results:

Component Title

Specifies the title for the results.

Border

Specifies border thickness. Values are Thick, Medium, Thin, or None. Default is Thin.

Show Search Input

Shows the search input on the results page.

API Access Requester

The API Access Requester component enables community members to request access to an API for either a new or existing application.

Community members can either request access for an existing client application and API instance, or request to create a new client application with access to the API by specifying the application name and description and choosing an API instance.

You can specify values for the following parameters of the API Access Requester:

API

Specifies the API.

Button Border Radius

Selects the button border radius. A larger radius makes the button look more rounded.

Button Align

Specifies left, right, or center button alignment.

Show Modal Title Line

Shows the title line in the access request modal.

API Card

The API Card component shows information about an API, including icon, name, and description.

The API icon, name, and description shown are set in the API Community Manager control panel when you add an API version to your community.

You can specify values for the following parameters of the API Card:

API

Specifies the API shown.

Override URL

By default the API Details button links to the API main page. You can optionally set the Override URL to direct users to other information such as documentation or marketing collateral.

Show Buttons

Shows the API Details button. If the button is not shown, users can click anywhere on the card to show the API details.

Card Height

Specifies the card height.

Card Margin

Specifies the amount of margin space around the card.

Card Border

Specifies the card border thickness.

Card Border Radius

Specifies the card border radius. A larger radius makes the cards look more rounded.

Card Shadow

Specifies the shadow beneath the card.

API Details Button Label

Enables you to set the API Details button label. Default is API Details.

Learn More Button Label

Enables you to set the Learn More button label. Default is Learn More.

The API Carousel component shows a horizontally scrollable set of API cards.

The API icon, name, and description shown are set in the API Community Manager control panel when you add an API version to your community.

You can specify values for the following parameters of the API Carousel:

Show Buttons

Shows the API Details button on each card. Users can see API details by clicking the button if it is present or by clicking anywhere on the card if it is not.

Max Cards Display

Specifies the maximum number of cards to show.

Rows

Specifies the number of rows of cards in the carousel.

Show Arrows

Shows arrows on the carousel’s right and left sides. Clicking the arrows scrolls through the cards in the direction of the arrow clicked.

Arrow Size

Specifies the size of the arrows on the right and left sides.

Show Dots

Shows dots below the cards. Each dot links to a page of cards in the carousel.

Card Height

Specifies the card height.

Card Margin

Specifies the margin space around each card.

Card Border

Specifies the card border thickness.

Card Border Radius

Specifies the card border radius. A larger radius makes the cards look more rounded.

Card Shadow

Specifies the shadow beneath each card.

Message If Empty

Shows a message if the carousel has no APIs. Default is There are no APIs available right now.

Filter Condition (Advanced)

Causes the carousel to show only APIs that match the given search condition, which uses the syntax described in Filter Conditions.

Categories Filter (Advanced)

Causes the carousel to show only APIs that match the given categories, using the syntax described in Categories Filter.

API Details Button Label

Enables you to set the API Details button label. Default is API Details.

Learn More Button Label

Enables you to set the Learn More button label. Default is Learn More.

API Catalog

The API Catalog component offers API consumers an interactive way to explore all the available APIs in an API community. It shows API cards in rows and columns, divided into pages, and controls to filter the displayed APIs by categories and search terms. The catalog is suitable for displaying and exploring large numbers of API versions.

In the template community, the link to the API Catalog component appears below the API Carousel component. If a community has multiple API Catalog instances on multiple pages, the best practice is to standardize the pages and place the instances as consistently as possible.

To prevent confusion, the API Catalog component is designed to use a maximum of five managed categories, and not tags.

After you add a new category in Anypoint Exchange, it appears in the API Catalog configuration within five minutes when the cache refreshes automatically.

The API Catalog configuration shows a category only if at least one API has a value for that category.

If a category is removed or modified in Exchange, all API Catalog instances automatically reflect the change.

A card can have multiple badges from one category. It can display up to three badges and, if it has more, it offers a tooltip to display them.

If you do not specify category colors, your community theme is used as the default. Colors can be hexadecimal values such as #FF0000 or #0000FF or standard CSS color names such as red and blue.

You can use URL parameters to pass filters to the catalog. For example, the URL of the page with the catalog component can end with ?catalogFilters=Country:Argentina,USA;Payment:Cash,Credit.

The API icon, name, and description shown are set in the API Community Manager control panel when you add an API version to your community.

You can specify values for the following parameters of the API Catalog component:

Component Title

Specifies the catalog title. Default is API Catalog.

Show API Counter

Enables you to show the API counter, which displays the number of APIs that match the current search and filters.

APIs Per Page

Specifies the number of APIs shown on each page of the catalog. Default is 12.

Category Filter 1 through Category Filter 5

Specifies the categories that community members and guest users can use to filter the APIs. Default is None.

Category Color 1 through Category Color 5

Specifies the color for each category.

Search Input Position

Specifies whether the search box is next to the filters or below the filters and above the cards.

Category Card Badge 1 through Category Card Badge 3

Specifies the categories that appear at the top of the cards as badges, with colors matching the category colors.

Filter Condition (Advanced)

Causes the catalog to show only APIs that match the given search condition, which uses the syntax described in Filter Conditions.

Categories Filter (Advanced)

Causes the catalog to show only APIs that match the given categories, using the syntax described in Categories Filter.

API Console

The interactive API Console component shows information about your APIs and their methods, and enables users to test the methods by sending requests.

Endpoints are displayed in alphabetical order.

Console components include API Console, API Console Documentation, API Console Instances, API Console Navigation, and API Console Request Panel. In Community Builder, you can add multiple console components to the same page. Changes to a console component are visible in all other console components on that page that display the same API. For example, selecting the Summary tab in an API Console results in Summary tab selection in all API Consoles on the same page that display the same API.

The component shows the API instances and documentation from Anypoint Exchange.

You can specify values for the following parameters of the API Console:

API

Specifies the API to display.

Show Documentation Pages

Shows the API’s documentation pages.

Link Hover Color

Specifies the hover link color.

Button Text Color (Optional)

Specifies the color of button text.

Button Hover Text Color (Optional)

Specifies the color of button hover text. Default is the button text color.

Headline Font Family (Optional)

Specifies the API console headline font family.

Error Color (Optional)

Specifies the color of error messages.

Method Label Get Background Color

Specifies the GET method label background color.

Method Label Get Color

Specifies the GET method label color.

Method Label Post Background Color

Specifies the POST method label background color.

Method Label Post Color

Specifies the POST method label color.

Method Label Put Background Color

Specifies the PUT method label background color.

Method Label Put Color

Specifies the PUT method label color.

Method Label Delete Background Color

Specifies the DELETE method label background color.

Method Label Delete Color

Specifies the DELETE method label color.

Method Label Patch Background Color

Specifies the PATCH method label background color.

Method Label Patch Color

Specifies the PATCH method label color.

Method Label Options Background Color

Specifies the OPTIONS method label background color.

Method Label Options Color

Specifies the OPTIONS method label color.

Method Label Head Background Color

Specifies the HEAD method label background color.

Method Label Head Color

Specifies the HEAD method label color.

API Console Documentation

The API Console Documentation component shows the documentation about an API from Anypoint Exchange.

You can specify values for the following parameters of the API Console Documentation:

API

Specifies the API to display.

Show Documentation Pages

Shows the API documentation pages.

Method Label Get Background Color

Specifies the GET method label background color.

Method Label Get Color

Specifies the GET method label color.

Method Label Post Background Color

Specifies the POST method label background color.

Method Label Post Color

Specifies the POST method label color.

Method Label Put Background Color

Specifies the PUT method label background color.

Method Label Put Color

Specifies the PUT method label color.

Method Label Delete Background Color

Specifies the DELETE method label background color.

Method Label Delete Color

Specifies the DELETE method label color.

Method Label Patch Background Color

Specifies the PATCH method label background color.

Method Label Patch Color

Specifies the PATCH method label color.

Method Label Options Background Color

Specifies the OPTIONS method label background color.

Method Label Options Color

Specifies the OPTIONS method label color.

Method Label Head Background Color

Specifies the HEAD method label background color.

Method Label Head Color

Specifies the HEAD method label color.

Headline Font Family (Optional)

Specifies the API console headline font family.

API Console Instances

The API Console Instances component shows the list of instances of an API, also known as endpoints.

The component shows the API instances from Anypoint API Manager.

You can specify values for the following parameters of the API Console Instances:

API

Specifies the API whose instances are displayed.

API Console Navigation

The API Console Navigation component shows the API console component’s navigation.

The component shows the API instances and documentation from Anypoint Exchange.

You can specify values for the following parameters of the API Console Navigation:

API

Specifies the API to display.

Show Documentation Pages

Shows the API’s documentation pages.

Method Label Get Background Color

Specifies the GET method label background color.

Method Label Get Color

Specifies the GET method label color.

Method Label Post Background Color

Specifies the POST method label background color.

Method Label Post Color

Specifies the POST method label color.

Method Label Put Background Color

Specifies the PUT method label background color.

Method Label Put Color

Specifies the PUT method label color.

Method Label Delete Background Color

Specifies the DELETE method label background color.

Method Label Delete Color

Specifies the DELETE method label color.

Method Label Patch Background Color

Specifies the PATCH method label background color.

Method Label Patch Color

Specifies the PATCH method label color.

Method Label Options Background Color

Specifies the OPTIONS method label background color.

Method Label Options Color

Specifies the OPTIONS method label color.

Method Label Head Background Color

Specifies the HEAD method label background color.

Method Label Head Color

Specifies the HEAD method label color.

API Console Request Panel

The API Console Request Panel component shows a panel where users can test an API by making requests to it.

The component shows the API instances from Anypoint API Manager.

You can specify values for the following parameters of the API Console Request Panel:

API

Specifies the API to display.

Show Documentation Pages

Shows the API’s documentation pages.

Method Label Get Background Color

Specifies the GET method label background color.

Method Label Get Color

Specifies the GET method label color.

Method Label Post Background Color

Specifies the POST method label background color.

Method Label Post Color

Specifies the POST method label color.

Method Label Put Background Color

Specifies the PUT method label background color.

Method Label Put Color

Specifies the PUT method label color.

Method Label Delete Background Color

Specifies the DELETE method label background color.

Method Label Delete Color

Specifies the DELETE method label color.

Method Label Patch Background Color

Specifies the PATCH method label background color.

Method Label Patch Color

Specifies the PATCH method label color.

Method Label Options Background Color

Specifies the OPTIONS method label background color.

Method Label Options Color

Specifies the OPTIONS method label color.

Method Label Head Background Color

Specifies the HEAD method label background color.

Method Label Head Color

Specifies the HEAD method label color.

Link Hover Color

Specifies the color of links when the cursor hovers over them.

Button Text Color (Optional)

Specifies the color of button text.

Button Hover Text Color (Optional)

Specifies the color of button hover text. Default is the button text color.

Headline Font Family (Optional)

Specifies the headline font family.

Error Color (Optional)

Specifies the color of error messages.

API Details Button

The API Details Button component provides portal users with details about an API.

You can specify values for the following parameters of the API Details Button:

API

Specifies the API to display.

Button Label

Specifies the button label. Default is API Details.

Button Align

Specifies button alignment as left, right, or center of the UI field.

API Name

Adds the API name to the button label. Values are Append, Prepend, or None. Default is None.

API Version

Adds the API version to the button label. Values are Append, Prepend, or None. Default is None.

API Documentation Viewer

The API Documentation Viewer component shows an API’s documentation from Anypoint Exchange. The documentation can have multiple pages, and each page can have multiple sections.

You can specify values for the following parameters of the API Documentation Viewer:

API

Specifies the API.

Section (Optional)

Selects the section to open. If the Selected page (optional) setting is empty, the Section (optional) setting is ignored.

Selected Page (Optional)

Selects the page to open.

API Header

The API Header component displays the API header, including icon, name, and description.

The API icon, name, and description shown are set in the API Community Manager control panel when you add an API version to your community.

You can specify values for the following parameters of the API Header:

API

Specifies the API to show.

Application Analytics Graph

The Application Analytics Graph component displays statistics about the use of an application, such as traffic, response time, and application health.

The component shows the application statistics from Anypoint API Manager.

You can specify values for the following parameters of the Application Analytics Graph:

Application

Specifies the application to show.

Application Details

The Application Details component displays details about an application.

The component shows the application description, application URL, redirect URIs, client ID, and client secret from Anypoint API Manager.

You can specify values for the following parameters of the Application Details:

Application

Specifies the API to show.

Application Listing

The Application Listing component shows applications that use an API.

The component shows the application name, client ID, and client secret from Anypoint API Manager.

You can specify values for the following parameters of the Application Listing:

New Application URL

Specifies a new application URL.

Card Margin

Specifies the amount of margin space around the card.

Card Border

Specifies the card border thickness.

Card Border Radius

Specifies the card border radius. Cards with a larger radius look more rounded.

Card Shadow

Specifies the shadow beneath the card.

Card Width

Specifies the card width.

Card Height

Specifies the card height.

Learn More Button

The Learn More Button component provides portal users with a custom page with additional information about the API.

You can specify values for the following parameters of the Learn More Button:

API

Specifies the API to display.

Button Label

Specifies the button label. Default is Learn more about this API.

Button Align

Specifies button alignment as left, right, or center of the UI field.

API Name

Adds the API name to the button label. Values are Append, Prepend, or None. Default is None.

API Version

Adds the API version to the button label. Values are Append, Prepend, or None. Default is None.

Login Form

The Login Form component enables community members to log in to the portal.

You can specify values for the following parameters of the Login Form:

Start URL

Specifies the URL that members see after they log in. The default value is the portal home page.

Username Label

Specifies the username field label. Default is Email.

Password Label

Specifies the password field label. Default is Password.

Login Button Label

Specifies the login button label. Default is Log in.

Forgot Password Label

Specifies the forgotten password link label. Default is Forgot your password?.

Forgot Password URL

Specifies the forgotten password link URL. Default is /ForgotPassword.

Self Register Label

Specifies the self-registration link label. Default is Not a member?.

Self Register URL

Specifies the self-registration link URL. Default is /SelfRegister.

Self Register

The Self Register component enables users to register for portal accounts.

You can specify values for the following parameters of the Self Register component:

Start URL

Specifies the start URL. Default is the portal home page.

Confirm URL

Specifies the confirmation URL. Default is /CheckPasswordResetEmail.

First Name Label

Specifies the first name field label. Default is First Name.

Last Name Label

Specifies the last name field label. Default is Last Name.

Email Label

Specifies the email address field label. Default is Email.

Password Label

Specifies the password field label. Default is Create Password.

Confirm Password Label

Specifies the password confirmation field label. Default is Confirm Password.

Submit Button Label

Specifies the submit button label. Default is Sign Up.

Include Password Field

Shows the password field.

Extra Field Set

Specifies extra fields.

Registrations Require Approval

Select whether registration requires approval.

Approver ID

Specifies the approver ID.

Filter Conditions

The API Carousel component and the API Catalog component use the parameter Filter Condition (Advanced) to show only the APIs that meet the condition (a standard search in Salesforce Object Query Language (SOQL)).

Conditions can use these fields:

  • acm_pkg__Icon__c

  • acm_pkg__Name__c

  • acm_pkg__NavigateUrl__c

  • acm_pkg__VersionGroup__c

These examples demonstrate filter conditions:

  • acm_pkg__Name__c = 'My API': The API name is exactly equal to My API.

  • acm_pkg__Name__c LIKE '%My API%': The API name contains the text My API.

  • (NOT acm_pkg__Name__c LIKE '%BETA%'): The API name does not contain the text BETA.

  • (acm_pkg__Name__c = 'API Alpha' OR acm_pkg__Name__c = 'API Bravo'): The API name is API Alpha or API Bravo.

  • (acm_pkg__Name__c = 'My API' AND acm_pkg__VersionGroup__c = 'v1'): The API name is My API and the API version group is v1.

  • (acm_pkg__Name__c LIKE 'Product%' OR acm_pkg__Name__c LIKE 'Shipping%' OR acm_pkg__Name__c LIKE 'Order%'): The API name begins with Product, Shipping, or Order.

  • acm_pkg__Icon__c != '': The API has an icon.

  • acm_pkg__NavigateUrl__c != '': The API has a Learn More button that links to a custom page with more information.

  • acm_pkg__VersionGroup__c = 'v2': The API version group is exactly equal to v2.

  • acm_pkg__VersionGroup__c > 'v1': The API version group is later than v1.

  • acm_pkg__VersionGroup__c < 'v1': The API version group is earlier than v1.

  • acm_pkg__VersionGroup__c >= 'v2': The API version group is later than or equal to v2.

  • acm_pkg__VersionGroup__c <= 'v2': The API version group is earlier than or equal to v2.

Queries using OR or AND must enclose the whole condition in parentheses.

API Community Manager compares version groups using normal string comparison.

You can learn more about SOQL from the Salesforce SOQL and SOSL Reference.

Categories Filter

The API Carousel component and the API Catalog component use the parameter Categories Filter (Advanced) to show only the APIs that have categories in Anypoint Exchange with the specified values.

These categories and values are written as comma-separated pairs such as Country=Argentina,Payment=Credit.

The API Carousel or API Catalog will show only APIs that match all of the category-value pairs in the categories filter and all of the filter conditions.

We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used and to tailor advertising. You can read more and make your cookie choices here. By continuing to use this site you are giving us your consent to do this.