文档
调用网关所需的一切 —— 所有金融科技集成共用同一套契约。
快速开始
所有端点都位于同一个基础 URL 之下,并遵循相同的约定:
https://api.openbankinggateway.com
每个 App 页面都内置在线调试台 —— 填入参数并点击 Send request 即可,无需任何客户端配置。完整的机器可读规范见 OpenAPI / Swagger UI.
一次典型的集成分为三步:
- 登录 —— 使用账号凭据 / OTP 调用该 App 的登录端点。
- 保存 token —— 登录成功后会返回一个网关
token。 - 调用端点 —— 在每个需要鉴权的请求上带上
token=。
身份认证
每个 App 都采用其底层金融科技原生的登录流程(短信 OTP、用户名/密码、PIN + OTP)。成功后网关会签发自己的会话 token:
{
"code": 200,
"data": {
"status": "Login successful",
"token": "<gateway session token>",
...
}
}
将该 token 作为 token= 查询参数传给后续每个端点。网关会在服务端把它解析为上游会话 —— 你无需再接触上游凭据。
Token 与登录所用的账户绑定。若上游会话过期,重新登录即可获取新的 token。
响应格式
每个响应 —— 无论成功或失败 —— 都包裹在同一个结构中:
{
"code": 200, // HTTP-style status of the gateway call
"data": {
..., // normalized fields from the fintech app
"upstream": { ... } // the raw, untouched upstream JSON
}
}
data.upstream 字段始终携带原始的金融科技响应,因此你既可以方便地使用归一化字段,也能在需要 App 专有细节时审计或解析原始报文。
错误码
| 状态码 | 含义 |
|---|---|
400 | 参数校验错误 —— 缺少参数或格式不正确。 |
401 | 凭据无效、token 错误/过期,或没有有效会话。 |
502 | 无法连接上游金融科技 App,或上游返回错误。 |
凭据类与上游类错误在可用时仍会附带 data.upstream,因此上游自身的错误信息绝不会对你隐藏。
可用 API
每个集成都随附完整的端点文档和在线调试台: