Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

‌The API Catalog allows you to browse through APIs as well as search APIs directlyor to search for specific APIs.

Select A View

You can view the APIs that are available in the API Catalog by selecting one of the following two views:

  • Grid View: (default Default view) APIs are represented by tiles that contain details about the APIEach card represents an API and includes details, such as the version, the creator, and the date when the API version was last updated. Only some APIs are displayed in the Catalog. To scroll through , and a short description of the API. The card might also include a Featured pill at the top (if it is a featured API) and several pills for each tag at the bottom (if tags are assigned to the API). To view more APIs, click View More.

  • List View: In this view, APIs are listed in on a scrolling page with columns indicating the version, creator, last time updated, a truncated description which you can expand, and tags.

...

Search for APIs

You can To search the API catalog for APIs using search terms based on the following , enter your search string in the Search field and press Enter. Your search string will be compared with the following API attributes:

  • API Name

  • Version

  • Created By

  • Description

  • Tags

...

In the top right corner of the API catalog, enter your terms in the Search field.

...

You can further filter the search results by clicking the available categories on the left navigation pane.

Anchor
explore-api
explore-api
Explore an API

...

  • Version: The version of the API.

  • Created by: The creator of the API.

  • Updated: The last time the API version was updated.

  • Base URLCreated by: The endpoint by which you can invoke creator of the API.

  • Description: A description of the API functionality.

  • Tags: Metadata labels of the API used to categorize the API contents.

  • Other Versions: Other versions of the API, which can be accessed through the version link.

  • Contact: The contact information (email and Slack) of the administrator of the API.

  • Categories: The API Catalog categories under which the API falls.

  • Base URL: The endpoint through which you can invoke the API.

  • OAS Version: The Open API Specification version that the API was created with.

You can also view the various HTTP methods and endpoints of the API below the details.

To subscribe to the API, click the Subscribe button, then select or create the application to which you want to add the subscription.

...

Prerequisites

...