Pin and Unpin APIs
Pinning an API and setting an API as a favorite are different features and function differently.
What
Users can pin and unpin existing APIs. When you pin an API, that API then shows up in the other modules without having to search or filter for it.
- NOT Session-specific—Pinning is NOT session-specific and stays through log out and log in and does not change until the user changes it.
- User-specific—Pinning is user account-specific and only seen by the team member who pins or unpins the API.
- No Confirmation message—A system confirmation message does NOT appear in the upper right of the page, when pinning and unpinning any API.
Where
Where to pin and unpin, and where is it seen:
- Pinning and unpinning APIs is performed on the API Catalog Page.
- Pinned APIs are visible only to the team member who pinned the APIs, in any and all browsers, and are not visible to other team members who access the API Catalog.
- Pinned APIs are visible in the following parts of the PortX Platform:
- Discover Module—API Catalog—pinned APIs are part of the page of APIs and show they are pinned ONLY by the pin icon in the upper right
- Develop Module—API Designer—only shows pinned APIs that have the Karavan template. All other templates do not show as pinned in this module.
- Transform Module—only shows pinned APIs that have the Karavan template.
When
When should pinning be used or not used? As needed. Pinning works well with APIs with Karavan templates but not any of the other templates.
Who
Who should use pinning? All users.
Why
Why use pinning? Ease of use and do not need to load or find a particular API again during that session.
How
How to use pinning? Instructions and screen captures are provided here in this section of the PortX Platform documentation.
To pin an API, click on the outline of the tilted pushpin symbol in the upper right of the API Information Box for that API, as shown in Figure 5.
The pinned API has its pushpin symbol now colored in dark blue and appears upright as shown in Figure 6.
To UNpin an API, click on the dark blue upright pushpin symbol in the upper right of the API Information Box for that API, as shown in Figure 6.
The unpinned API has its pushpin symbol now as an outline, and appears tilted as shown in Figure 5.
When an API is pinned and you open the Develop Module, you see the details for that API as shown in Figure 7.
When an API is pinned and you open the Transform Module, you see the details for that API as shown in Figure 8.