Introduction the Discover Module, the API Catalog
Introduction
The Discover Module is your API Catalog and shows you all of your APIs.
Purpose
This document provides information and step-by-step walkthroughs for the following topics:
- Search or filter APIs
- Pin and Unpin APIs
- Set and Unset Favorite APIs
- Add or Create a New API
- Edit of Change an API
- Delete an API
Initialisms
Initialism | Definition |
---|---|
API | Application Programming Interface |
AWS | Amazon Web Services |
DSL | Domain Specific Language |
CD | Continuous Delivery |
ECR | Elastic Container Registry |
MFA | Multi-Factor Authentication |
RDS | Relational Database Service |
SSO | Single Sign On |
VPS | Virtual Private Cloud |
VPN | Virtual Private Network |
What Are the APIs and How Do the APIs Appear in the API Catalog
APIs shown and listed are from 2 sources:
- PortX: a number of pre-built reusable APIs are provided by PortX, and PortX regularly adds to those.
- Your company: all APIs your company, you, and your team members have created.
APIs are created and added from 2 sources:
- New APIs are added by PortX regularly.
- New APIs that are added and created by your company, you, and your team members who are authorized to add new APIs.
Navigation to Open Discover Module—The API Catalog
From ANYWHERE in the PortX Platform, if you are not in the Integration Manager, click on the Integration Manager in the Left Navigation Product Menu (black color). The first symbol is the Integration Manager.
The PortX Integration Manager Main Page opens as shown in Figure 1.
From the PortX Integration Manager Main Page, click on Discover through either of 2 methods as shown in Figure 1:
- The Left Navigation PortX Integration Manager Module Menu—select the Discover icon (Figure 1 upper far left arrow)
- The Modules on the PortX Integration Manager Page—in the Discover Module box, click on the Open button (Figure 1 lower arrow)
The Discover Module Main Page or the API Catalog Page opens as shown in Figure 2.
The API Catalog Page, shown in Figure 2, shows the entire list of APIs available to you at this time. Scroll down to see all of them.