Browse APIs
The API Hub is the main page of the Developer Portal where you discover and explore available API products. This guide shows you how to browse, search, and review API documentation.
Access the API Hub
Navigate to the API Hub from the top navigation bar of the Developer Portal. The API Hub displays all published API products that are visible to you based on the product's visibility settings:
- Public products are visible to all visitors, including unauthenticated users (if public access is enabled on the portal).
- Logged-in products are visible only after you sign in.
Browse API Products
Each API product card in the API Hub displays:
- Name: The product display name.
- Description: A brief summary of what the API provides.
- Labels: Tags that categorize the product.
Click on a product card to view its details.
View API Product Details
The API product detail page shows:
API Documentation
For gateway products, the API documentation is generated from the OpenAPI specifications of the linked services. You can browse:
- Endpoints: All available API paths and HTTP methods.
- Request parameters: Path parameters, query parameters, headers, and request body schemas.
- Response schemas: Expected response formats and status codes.
- Server URLs: The base URLs where the APIs are hosted.
For external products, the documentation is rendered from the uploaded OpenAPI specification.
Authentication Requirements
The detail page shows which authentication types the product supports (key auth, basic auth, or OAuth). This helps you understand what type of credential you will need to create after subscribing.
Subscription Status
If you are signed in, the page shows whether your applications are already subscribed to this product.
Visibility and Access
What you can see in the API Hub depends on the product configuration:
| Your status | Public products | Logged-in products |
|---|---|---|
| Not signed in | Visible (if public access is enabled) | Not visible |
| Signed in, not subscribed | Visible. API details may be visible depending on product settings. | Visible. API details may be visible depending on product settings. |
| Signed in, subscribed | Full access | Full access |
Some products may allow unsubscribed developers to view API documentation but restrict certain content (such as the Try It Out feature) to subscribed developers only.
Next Steps
After finding an API product that meets your needs:
- Register and log in if you do not have an account.
- Create an application to organize your subscriptions and credentials.
- Subscribe to the API to request access.