Create a self-service portal to showcase API products to external developers and manage their registrations and subscriptions.
What is a portal
A portal is a self-service site for external developers on the open platform. Administrators create portals in the console and publish API products to them. Developers register an account, then browse and subscribe to published API products. Each portal has independent configuration and API product collections.
With a portal, you can:
-
Showcase API products for developers to browse and search.
-
Manage developer registrations and subscriptions with automatic or manual approval.
-
Provide an entry point for AI APIs (HiChat) so developers can quickly access AI capabilities.
Create a portal
-
Sign in to the open platform console.
-
Click Create portal.
-
In the dialog box, configure the following parameters:
Parameter
Description
Name
A unique portal name. Example:
ai-platform.Description
A brief description to help administrators identify the portal.
-
Click OK.
Configure a portal
After creating a portal, click its card on the portal list page to open the details page. You can configure the following modules.
Portal overview
View basic portal information such as name, description, and related statistics.
Published API products
Publish new API products to the portal or unpublish existing ones.
Developer management
On this page, you can:
-
View registered developers.
-
Approve registration requests.
-
View API product subscriptions.
Security settings
Configure approval policies for developer registration and subscription.
-
Automatic developer approval: When enabled, new registrations are approved automatically. When disabled, an administrator must approve each registration manually.
-
Automatic subscription approval: When enabled, subscriptions are approved automatically. When disabled, an administrator must approve each subscription manually.
Delete a portal
-
On the portal list page, click Delete portal in the upper-right corner.
-
In the confirmation dialog box, click OK.
Deleting a portal removes all registered developer accounts and unpublishes all API products. Proceed with caution.
Next steps
After creating a portal, prepare it for developers:
-
Publish API products to the portal for developers to browse and subscribe.
-
Process registration applications and approve subscription requests on the Developer management page.