Collections
API collections can be used to group together public APIs with a common characteristic.
An API can appear in multiple collections
It is possible for one API to appear in multiple collections. This is unlike API Categories, where an API can only have a single API category associated with it.
APIs in a collection must be public
Only public APIs and spotlights can appear in collections. Private APIs can not be displayed on the API Hub page.
To create a new API collection, first navigate to your Admin Panel, then select the Collections tab.
Under the Collections tab, select the + in the bottom right corner.
Admin Panel Collections tab
When creating a collection, you can define the following information:
| - Title [Required] |
| - Slugified URL [Required] (Primarily used for SEO purposes and generates the URL to access the collection) |
| - Brand (Not currently used) |
| - Items (The list of public APIs and spotlights that will be grouped together in the collection) |
| - Weight (Determines how high the on the homepage the collection will be displayed. The lower the weight, the higher it is displayed. For example, a weight of 1 will display at the top of the homepage) |
| - Short Description (Used for the tile card that is displayed on the homepage) |
| - Long Description (Displayed at the bottom of the API collection page. Can be used for SEO to increase the ranking of the API collection in search) |
Collection spotlights
When grouping together specific APIs, you may have additional resources such as blogs or tutorials that can be helpful when exploring the API collection. Collection Spotlights enable you to embed external url links within an API collection.
From within the Edit screen, in the items field, you can type the following syntax
spotlight:{{desired URL link}} and then Enter.
Once a spotlight has been added to a collection, it will be display as an embedded card within the collection.
Updated 25 days ago