Skip to main content

​
前提条件

您已被分配为 Cobo Portal 中的操作员，经理或管理员用户角色。

​
步骤

​
在 Cobo Portal 中注册 API Key

推荐您使用长期 API Key，并根据以下步骤设置 IP 白名单和 Callback Endpoint。
  1. 登录 Cobo Portal。
  2. 在主菜单中点击开发者图标。
  3. 点击 WaaS 2.0 标签，然后切换到 API Keys 标签页。
  4. 点击注册 API Key 打开注册 API Key 对话框。 注册 API Key 对话框
  5. 输入 API Key 的名称（最多 30 个字符）。
  6. 输入 API Key 和选择加密算法。API Key 是密钥对中的公钥，长度必须为 64 个字符，只能包含数字 0 至 9 和字母 A 至 F。如想了解如何使用 Ed25519 算法生成 API Key，请参阅 Generate an API key and an API secret。
  7. 在用户角色 & 钱包范围板块，点击为用户角色设置钱包范围来设置该 API key 的用户角色以及可访问的钱包范围。
  8. 从对应的下拉列表中选择该 API Key 的用户角色以及可访问的钱包范围。 设置用户角色的钱包范围对话框 您可以点击每个角色来为每个用户角色选择不同的钱包范围。 设置用户角色的钱包范围对话框
    该 API Key 将获得您所勾选的用户角色下的权限并有访问选定钱包的权限。请妥善配置角色，钱包范围尽量不要选择任何类型钱包。
    点击确认来完成配置。
  9. 选择此 API Key 使用的 Callback Endpoint，或注册一个新的 Callback Endpoint。所选的 Callback Endpoint 将接收由该 API Key 触发的消息。有关更多信息，请参阅注册 Callback Endpoint。
  10. 选择 Key 类型。
    • 长期: 此 Key 类型需要 IP 地址白名单以增强安全性。您必须指定发送 API 请求的静态 IP 地址。如果有多个 IP 地址，请用逗号分隔。
      避免在 API Playground 中使用长期 Key，因为请求是从 API Playground 发送的，而不是从您指定的 IP 地址发送的。
    • 临时: 临时 Key 在 30 天后过期。如果您还没有准备好静态 IP 地址，可以选择此选项。
  11. 按照屏幕上的说明完成注册。
  12. 在安全验证对话框中，使用多重身份验证（MFA）方式验证您的身份。 安全验证对话框
身份验证成功后，您的注册 API Key 请求已提交。

​
在 Cobo Guard 中审批请求

根据您所在团队设置的业务风控规则，该请求可能需要特定数量的团队管理员在 Cobo Guard 上审批。您可以通过点击左下角的个人资料图标 > 团队 > 业务风控 > 开发者查看注册 API Key 的审批规则。 管理 API Key 审批规则 管理员需要打开 Cobo Guard，找到该请求对应的通知，并点击批准。 批准 API Key 请求 当审批通过后，API Key 注册成功，您会看到该 API Key 状态变为活跃中。 API Key 活跃状态

​
后续步骤

注册 API Key 后，您可以：
  • 编辑 API Key 的名称或相关 Callback Endpoint。
  • 让 API Key 失效以禁用与其相关的所有未来 API 访问。
  • 根据状态或类型过滤 API Key 列表，以便高效管理 API Key。 API Key 的状态包括：
    • 活跃中：API Key 正常工作。
    • 已失效：API Key 已被禁用，无法使用该 API Key 访问 WaaS 2.0 服务。
    • 新建审批中：API Key 的新建操作正在等待审批。
    • 失效审批中：API Key 的失效操作正在等待审批。
    • 更新审批中：API Key 的更新操作正在等待审批。
  • 使用名称或关键字搜索特定的 API Key。
欢迎提交您的反馈，帮助我们持续优化文档质量！