跳到主要内容

API门户管理

目录​


API 门户管理模块,聚焦 API 门户全生命周期管控,覆盖门户信息管理、访问及用户准入流程,助力企业规范 API 门户运营,保障服务有序开放与使用。

一、功能操作指南​

(一)门户信息管理列表​

构建 API 门户 “总览看板”,集中呈现已创建门户的核心信息,支持快速检索与状态监控,是管理员全局管理门户的基础入口。

API服务管理-API门户管理
  • 详细信息:以列表形式展示门户关键数据,包含门户图标、API 门户名称(如 “银行核心业务门户”“第三方合作伙伴门户” )、所属机构名称(信息科技部、合作发展部等 )、门户描述(明确门户用途,如核心业务系统 API 管理、第三方伙伴服务提供 )、创建人、创建时间,直观呈现门户基本属性。
  • 操作入口:列表右侧关联 “编辑”“登录”“注册” 操作按钮,同时支持通过筛选器 + 搜索字段,精准定位目标门户,快速开展管理动作;支持 “新建” 拓展门户、“删除” 清理无效门户,灵活维护门户资源。

(二)门户功能操作​

门户功能操作赋予管理员灵活调整门户信息的能力,适配业务需求变化,确保门户信息精准、贴合实际场景。 点击门户信息列表中 “编辑” 按钮,唤起编辑弹窗,可对门户名称、所属机构、门户描述等内容进行修改。支持补充更清晰的门户功能说明、调整所属管理部门,完成后保存即可同步更新门户信息,保障门户对外展示与内部管理的一致性,助力 API 服务与组织架构适配。

  • 新建门户:可点击“新建”按钮进行创建门户。

    API服务管理-API门户管理-创建门户

    1.左侧-信息填写:填写API门户名称等相关信息进行创建门户,其中门户名称和门户英文名在租户内是唯一的,不可以重复。
    2.右侧-项目配置:配置门户拥有的项目,可勾选多个(最少一个)。登录门户以后,门户的左侧资源组就是所分配的多个项目的综合资源组。
    3.右侧-开发者配置:配置可以登录门户的开发者,可勾选多个。请您注意,一个开发者可以拥有多个门户。

  • 编辑门户:可点击“编辑”按钮进行编辑更新门户信息和门户配置。除了特定信息项不可编辑以外,其他信息项的操作与新建门户一致。

  • 搜索门户:可根据门户名称、门户状态(是否启用门户)来搜索门户。

  • 删除门户:可在列表左侧,对门户数据进行勾选,然后点击“删除”按钮,进行删除门户。

  • 启停门户:在操作列可对门户进行启停操作。如果关闭门户,则门户用户无法登录当前的门户。

  • 特别说明:
    1.演示门户:演示门户自动在默认租户下创建,不可删除。编辑时不能修改API门户名称和门户英文名。
    2.其他门户:可创建、删除、修改。编辑时不能修改门户英文名。
    3.门户URL:由租户英文名和门户英文名构成。

(三)门户操作特别说明​

  • 演示门户:演示门户自动在默认租户下创建,不可删除。编辑时不能修改API门户名称和门户英文名。
  • 其他门户:可创建、删除、修改。编辑时不能修改门户英文名。
  • 门户URL:由租户英文名和门户英文名构成。

(四)门户用户注册​

面向新用户,搭建 API 门户准入通道,规范收集用户信息,为门户注入合规、真实的使用主体,保障 API 服务调用的可追溯性。
点击门户信息列表中 “注册” 按钮,弹出 “用户注册” 表单,需填写邮箱、用户名、公司名称、部门、手机号、申请门户(下拉选择目标门户 )、密码、确认密码、申请理由(说明使用 API 门户的业务需求,如系统对接、数据获取等 )。填写完成提交后,进入门户用户审批流程(关联「门户用户管理」模块 ),经管理员审核通过,用户方可获得门户登录权限,从源头把控 API 门户使用人群质量。

API服务管理-API门户管理-门户用户注册
  • 特别说明:
    1.系统提供的门户用户注册入口有两个,一个是在API门户管理列表的“注册”按钮,一个是在门户登录页面的“立即注册”。
    2.提交门户用户注册申请以后,需要在【开发者管理】功能,对门户用户的申请进行审核,审核通过以后才能进行登录门户。

(五)访问与登录门户​

为已注册用户提供 API 门户访问入口,验证身份后进入专属操作界面,保障门户使用的安全性与针对性。 在门户信息列表点击 “登录” 按钮,跳转至门户登录页,用户输入账号密码(或关联统一身份认证体系 ),完成身份校验后,进入对应 API 门户。门户内可访问专属 API 资源、执行权限范围内操作(如 API 查询、调用申请 ),实现 “一人一户” 的个性化 API 服务使用体验,隔离不同业务场景的门户访问,降低信息泄露风险。

API服务管理-API门户管理-门户登录
  • 特别说明: 1.登录门户的账号必须是门户用户的邮箱号
    2.在同一个浏览器下,系统管理员可直接通过门户URL进入门户。(免登录)
    3.可在【开发者管理】功能对门户用户进行管理。

二、常见问题解答​

Q1:如何注册门户(用户侧视角 )​

  • 入口触发:在「API 门户管理」列表,找到目标门户(如 “银行核心业务门户”“第三方合作伙伴门户” ),点击操作栏 「注册」 按钮,唤起「用户注册」弹窗 。
  • 信息填写按表单要求,依次填写:
    • 基础身份:邮箱、用户名、密码、确认密码(用于登录验证 );
    • 企业关联:公司名称、所属部门、手机号(明确用户所属组织与联系方式 );
    • 业务关联:申请门户(默认选中触发注册的门户 )、申请理由(说明注册用途,如 “对接银行核心 API 系统,实现业务数据交互” );
  • 提交审核:确认信息无误后,点击 「提交注册申请」,申请进入「门户用户管理 - 注册待审批」流程,经管理员审核通过后,完成门户注册,获得登录权限。