服务发布

服务发布是指在 Passport 平台上注册应用,定义 API 接口和权限,为后续接入做准备。

具体步骤

1. 创建应用

  1. 登录 Passport 管理后台
  2. 进入「应用」页面
  3. 点击「创建应用」

  1. 填写应用信息:
    • 应用名称(必填)
    • 描述(选填)
  2. 点击「确认」创建

创建成功后,系统会自动生成应用 ID,用于唯一标识该应用。

已知限制:当前版本服务端在创建应用时不会自动生成 App Key,该字段需要另行配置。详见「高阶操作」的应用管理章节。

2. 创建应用账号

应用需要账号来进行服务间认证(如调用 Passport 公开接口)。

  1. 进入「账号」页面
  2. 切换到「应用账号」标签
  3. 点击「创建账号」
  4. 填写以下信息:
    • 用户 ID(必填)
    • 名称(必填)
    • 所属应用(必填,选择刚创建的应用)
    • 描述(选填)
  5. 点击「确认」创建

3. 获取 Access Key

应用账号创建后,需要获取凭证用于 API 调用。

  1. 进入应用账号详情
  2. 切换到「凭证」标签
  3. 点击「创建凭证」
  4. 系统自动生成:
    • Access Key ID
    • Secret Access Key
  5. 保存凭证信息

重要:Secret Access Key 只在创建时显示一次,请立即保存!

4. 定义 API 接口

将应用的 API 接口清单注册到 Passport 平台。

  1. 进入应用详情
  2. 切换到「接口」标签
  3. 点击「创建接口」
  4. 填写接口信息:
    • 接口名称(必填)
    • 请求路径(必填,如 /api/user/*
    • 请求方法(必填,支持 GET/POST/PUT/DELETE)
    • 描述(选填)
  5. 点击「确认」创建

重复以上步骤,将所有接口注册到平台。

5. 导出接口列表

应用管理支持导出接口列表,方便在开发过程中使用。

  1. 进入应用详情
  2. 切换到「接口」标签
  3. 点击「导出」按钮
  4. 保存导出的文件

导出结果为 Excel 文件(.xlsx),文件名格式为 API-yyyyMMddHHmmss.xlsx,例如 API-20260830143022.xlsx。当前仅支持这一种格式。

6. 创建权限

定义应用的权限级别。

  1. 进入「权限」页面
  2. 点击「创建权限」
  3. 填写以下信息:
    • 权限名称(必填)
    • 所属应用(必填,选择刚创建的应用)
    • 描述(选填)
  4. 点击「确认」创建

建议为每个应用创建至少三个权限级别:

权限级别风险等级对应角色描述
管理员权限高风险管理员拥有应用的所有操作权限
操作者权限中风险操作者拥有大部分操作权限
只读权限低风险只读用户仅拥有查询权限

7. 关联接口到权限

将 API 接口关联到对应的权限。

  1. 进入权限详情
  2. 切换到「关联接口」标签
  3. 点击「添加接口」
  4. 选择要添加的 API(支持多选)
  5. 点击「确认」

重复以上步骤,将所有接口关联到对应的权限。

信息汇总

完成服务发布后,您将获得以下信息:

信息说明获取方式
应用 ID应用的唯一标识应用详情页
Access Key ID应用账号的访问密钥 ID凭证列表
Secret Access Key应用账号的密钥创建凭证时(仅显示一次)
接口清单所有已注册的 API应用详情页 > 接口标签
权限清单所有已创建的权限权限列表页
API-权限映射接口与权限的关联关系权限详情页 > 关联接口标签

这些信息将在 SDK 集成和 API 调用时使用。