如何访问 API

在 B2CORE IB Back Office 中注册应用,选择其访问级别,使用凭据获取访问令牌,并调用 IB API

集成通过在 Back Office 中注册的应用访问 B2CORE IB API。每个应用都有客户端 ID、客户端密钥和一个访问级别,访问级别决定该应用能否更改数据。本文介绍如何注册应用并发起首次 API 调用。

注册应用

前往介绍经纪商 > 偏好设置 > 应用。

点击注册新应用。

在应用名称字段中填写应用名称。

选择访问级别:

  • Read-only(默认选中)——应用可以调用所有 GET 操作并创建导出任务;使用该应用访问令牌发起的其他 POST、PUT、PATCH 或 DELETE 请求都会被拒绝。建议用于报表和监控集成。
  • Full access——应用可以调用所有 API 操作。

之后可以在应用详情页面更改访问级别。更改将从该应用的下一次 API 请求开始生效。

点击保存。

页面会跳转至新创建应用的详情页面,您可以在此查看应用名称、客户端 ID、客户端密钥、访问级别和 IP 白名单。

复制客户端 ID和客户端密钥,并将其保存在安全的位置。访问 API 时需要使用它们验证身份。客户端密钥只会在此页面显示一次,之后无法再次查看。

获取访问令牌

使用 HTTP Basic 身份验证向 /tokens 操作发送 POST 请求,以客户端 ID作为用户名、客户端密钥作为密码:

curl -X POST "{baseUrl}/tokens" \
  -u "CLIENT_ID:CLIENT_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"grant_type": "client_credentials"}'

将 {baseUrl} 替换为 B2BROKER 集成团队提供的 IB API 基础 URL。

从响应中复制 access_token 的值。响应还包含 token_type(Bearer)和 expires_in,后者表示令牌的有效期(以秒为单位)。请求新令牌会撤销该应用之前的令牌。

调用 API

在每个请求的 Authorization 标头中传入令牌:

curl "{baseUrl}/users" \
  -H "Authorization: Bearer ACCESS_TOKEN"

所有操作均列在 API 参考文档中。每个操作都会标明所需的访问权限:read(所有应用均可使用)或 write(仅限具有完全访问权限的应用)。

403 响应的含义

如果只读应用调用需要 write 权限的操作,API 会拒绝该请求,并返回 HTTP 403 和以下响应正文:

{
  "error": {
    "message": "This App is read-only and cannot perform this operation.",
    "code": "insufficient_scope"
  }
}

检查 code 字段:insufficient_scope 表示问题由应用的访问级别引起。要使请求成功,可以在介绍经纪商 > 偏好设置 > 应用中将该应用切换为Full access——更改从下一次请求开始生效,无需获取新令牌——也可以为需要更改数据的集成单独注册一个具有完全访问权限的应用。

唯一的例外是 POST /exports/async:只读应用可以创建导出任务,因此报表集成无需完全访问权限即可导出数据。

最后更新于

本页目录