API Key 权限(角色)¶
证据:ptrader-api-gateway/docs/API-Authentication-Mechanism.en.md、AuthFilter 角色校验。
一个 Key 可携带多个角色(逗号分隔的整数)。
| 角色 | 值 | 典型用途 |
|---|---|---|
| READ_ONLY | 0 | 余额、历史只读 |
| TRADE | 2 | 下单 / 撤单(tradeOnly / 写交易) |
| CONVERT | 3 | Convert(convertOnly) |
| CRYPTO_WALLET | 4 | 充提 |
| FIAT | 5 | 法币 |
| ACCOUNT | 6 | 账户管理(accountOnly) |
网关注解效果¶
| 注解标志 | 效果 |
|---|---|
needWrite=true |
拒绝纯只读 Key |
tradeOnly=true |
需要角色 2 |
convertOnly=true |
需要 convert 角色 |
accountOnly=true |
需要 account 角色 |
validKeyOnly=true |
跳过 HMAC,仅校验 Key |
checkRecvWindow=true |
强制 timestamp / recvWindow |
各接口精确角色组合见 OpenAPI security 与 ptrader-api-gateway 中 @SignAuth。[NEEDS-CONFIRMATION: 是否对外发布逐接口角色矩阵]
创建 Key¶
创建 Key / 查看 Secret 不属于本公开 OpenAPI 面(create-api-key 工具路由已排除)。请通过产品 UI / 批准的开通渠道办理。