面向外部开发者搭建 API 自助服务站点,集中展示和管理 API 产品、审批开发者注册、管理订阅关系。本文介绍如何创建、配置和管理门户。
什么是门户
门户(Portal)是开放平台中面向外部开发者的自助服务站点。管理员可以在控制台创建和配置门户,将 API 产品发布到门户;开发者访问门户后注册账号,即可浏览和订阅已发布的 API 产品。每个门户拥有独立的配置和 API 产品集合。
通过门户,你可以实现以下目标:
展示已发布的 API 产品,供开发者浏览和检索。
管理开发者注册和订阅,支持自动审批或手动审批。
提供 AI API 使用入口(HiChat),方便开发者快速调用 AI 能力。
创建门户
登录开放平台管理页面。
点击 创建门户。
在弹出的对话框中,填写以下信息:
参数
说明
名称
门户的唯一标识,用于区分不同的门户。例如
ai-platform。描述
简要描述门户的用途和定位,以便管理员快速识别。
点击 确定,完成创建。
配置门户
创建门户后,在门户列表页点击目标门户卡片进入详情页,可对以下模块进行配置和管理。
门户概览
查看门户的基础信息,包括名称、描述和相关统计数据。
已发布的 API 产品
管理当前门户中已发布的 API 产品,包括发布新产品到门户和从门户下架已有产品。
开发者管理
在开发者管理页面,你可以执行以下操作:
查看在该门户注册的开发者列表。
审批开发者的注册申请。
查看开发者的 API 产品订阅情况。
安全设置
配置审批策略,简化或规范开发者的注册和订阅流程。
开发者自动审批:开启后,开发者注册账号时审批自动通过;关闭后,需要管理员在开发者管理页面手动审批。
订阅自动审批:开启后,开发者订阅 API 产品时审批自动通过;关闭后,需要管理员在开发者管理页面手动审批。
删除门户
在门户列表页右上角,选择 删除门户。
在弹出的确认对话框中,点击 确定。
门户删除后,该门户上注册的开发者账号将被删除,已发布的 API 产品均会下架。请谨慎操作。
后续操作
创建门户后,你可以进行以下操作,让门户正式投入运行:
将 API 产品发布到门户,让开发者可以在门户中浏览和订阅。
在开发者管理中处理注册申请和审批订阅请求。