一、API Key 是什么

OSL Institution 支持通过 API Key 进行系统对接，让你可以用程序化的方式访问账户数据、发起交易等操作，不需要每次都登录网页手动操作。每个 API Key 都可以单独设置访问范围（Portfolio Level / Institution Level）和权限（Read-Only、Trade、Transfer、Withdraw），并且可以绑定 IP 白名单，降低泄露后被滥用的风险。

如果你所在的机构为"创建 API Key"这类操作设置了审批规则，新建 Key 时会先进入审批流程，审批通过后还需要手动完成一步激活才能正式使用——具体流程见下文第二节。

二、如何操作

2.1 创建 API Key

进入 API 页面，点击右上角 Create API，按 3 个步骤完成创建。

Step 1：Create

• Label（必填）：给这个 Key 起一个名字，8–32 位字母或数字

• Password（必填）：设置一个密码，8–32 位字母或数字。这个密码需要自己记住——如果这个 Key 后续命中审批规则，走完审批后需要用这个密码完成激活

• Access Level（必填）：

  • Portfolio Level：仅能访问当前这一个 Portfolio

  • Institution Level：可以访问机构下所有 Portfolio，包括未来新建的

• Permission settings（必填）：

  • Read-Only：仅能调用查询类接口（默认勾选，不可取消）

  • Trade：可以进行 Convert 和 StableHub 交易

  • Transfer：可以在 Portfolio 内部转账

  • Withdraw：可以发起提现；如果这个 Key 是 Institution Level，还可以用来创建 Portfolio

• Only allow access to specific addresses（必填）：绑定 IP 白名单，单个 Key 最多可绑定 30 个 IP，多个 IP 用逗号分隔

填写完成后点击 Next。

Step 2：Verify

输入邮箱验证码和 Google Authenticator 验证码，点击 Submit。

Step 3：Done

• 如果"创建 API Key"这项操作不需要审批：会直接显示 "API created successfully"，展示 Access API Key 和 Secret Key。Secret Key 只在这一次展示，务必当场保存好，之后无法再次查看

• 如果这项操作命中了审批规则：不会立即显示 Key，请求会先进入审批流程；这个 Key 此时会出现在 API 页面 → Pending API 标签下，状态为 Pending Activation，需要等审批通过后再完成激活（见下一步）

2.2 激活 API Key

这里有个容易漏掉的点：即使审批已经通过，Key 也不会自动生效，还需要手动完成激活这一步才能正式使用。

审批通过后，进入 API 页面 → Pending API 标签，找到对应的 Key，点击 Activate：

• 输入 API passphrase（也就是创建这个 Key 时 Step 1 里设置的 Password）

• 输入邮箱验证码和 Google Authenticator 验证码

• 点击 Next 完成激活

激活成功后，Access API Key 和 Secret Key 会被展示出来（同样只展示这一次），这个 Key 也会从 Pending API 移动到 Active API 标签下，状态变为 Activated，即可正式使用。

2.3 管理已有的 Key

• Active API 标签：展示已激活可用的 Key，字段包括 Label、API Key（脱敏展示）、Access Level、Permissions、Status、Active By（激活人和激活时间），支持 View / Edit / Delete

• Pending API 标签：展示还在等待激活的 Key，字段包括 Label、Access Level、Permissions、Status、Submit By（提交人和提交时间），支持 Activate / View

三、几个使用上要注意的地方

• Secret Key 只在创建成功或激活成功的那一刻展示一次，之后无法再次查看，务必当场妥善保存，避免丢失或泄露导致资产损失

• 为了安全，建议给每个 API Key 都绑定 IP 白名单，单个 Key 最多可绑定 30 个 IP