创建下级用户 API Key
- POST
/api/v3/accountCenter/apiKey
权重(IP): 5
为指定下级用户创建 API Key。创建成功后,secret 仅在本次响应中返回一次,请调用方妥善保存。
请求参数
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| subUserId | Long | 是 | 下级用户 UID。 |
| passphrase | String | 是 | API Key 口令。长度 8-31 位,仅允许英文字母或数字,不能包含空格或特殊符号。 |
| authorities | String[] | 否 | API Key 权限。未传时默认 ACCOUNT_DETAILS。 |
| ipWhiteList | String[] | 条件必填 | IP 白名单,最多 10 个。包含非只读权限时必填。 |
| remark | String | 否 | API Key 备注。 |
权限枚举
| 权限枚举 | 说明 |
|---|---|
ACCOUNT_DETAILS | 账户详情,只读权限。 |
SPOT_TRADING | 现货交易权限。 |
FUTURES_TRADING | 合约交易权限。 |
TRANSFER | 资金划转权限。 |
WITHDRAW | 提币权限。 |
请求示例
{
"subUserId": 1234567890,
"passphrase": "abc12345",
"authorities": ["ACCOUNT_DETAILS", "TRANSFER"],
"ipWhiteList": ["127.0.0.1"],
"remark": "sub user key"
}
返回参数
| 字段名 | 类型 | 字段说明 |
|---|---|---|
| subUserId | Long | 下级用户 UID。 |
| apiKey | String | API Key。 |
| secret | String | Secret Key,仅创建成功时返回一次。 |
| authorities | String[] | API Key 权限。 |
| ipWhiteList | String[] | IP 白名单。 |
返回示例
{
"subUserId": 1234567890,
"apiKey": "weex_xxxxxxxxxxxxxxxxxxxxxxxx",
"secret": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"authorities": ["ACCOUNT_DETAILS", "TRANSFER"],
"ipWhiteList": ["127.0.0.1"]
}