【API 公告】关于API将新增母子用户API key管理接口的公告

火币 2020-6-5 08:29

火币Global API将新增母子用户API key管理接口，详细如下：

- 子用户API key创建接口“POST /v2/sub-user/api-key-generation”，限母用户可用；
- 母子用户API key信息查询接口 “GET /v2/user/api-key”，限母用户可用；
- 子用户API key修改接口“POST /v2/sub-user/api-key-modification”，限母用户可用；
- 子用户API key删除接口“POST /v2/sub-user/api-key-deletion”，限母用户可用。

生效日期：2020年6月5日（GMT+8）

具体变更细节及参数要求，请参考API文档：https://huobiapi.github.io/docs/spot/v1/cn/

火币全球站
2020年6月5日

子用户创建

POST /v2/sub-user/api-key-generation

请求参数

参数名称	是否必须	类型	描述	默认值	取值范围
otpToken	true	string	母用户的谷歌验证码，母用户须在官网页面启用GA二次验证	NA	6个字符，纯数字
subUid	true	long	子用户UID	NA
note	true	string	API key备注	NA	最多255位字符，字符类型不限
permission	true	string	API key权限	NA	取值范围：readOnly、trade，其中readOnly必传，trade选传，两个间用半角逗号分隔。
ipAddresses	false	string	API key绑定的IPv4/IPv6主机地址或IPv4网络地址	NA	最多绑定10个，多个IP地址用半角逗号分隔，如：192.168.1.1,202.106.96.0/24。如果未绑定任何IP地址，API key有效期仅为90天。

响应参数

参数名称	是否必须	数据类型	描述	取值范围
code	true	int	状态码
message	false	string	错误描述（如有）
data	true	object
{ note	true	string	API key备注
accessKey	true	string	access key
secretKey	true	string	secret key
permission	true	string	API key权限
ipAddresses }	false	string	API key绑定的IP地址

母子用户API key信息查询

GET /v2/user/api-key

请求参数

参数名称	是否必须	类型	描述	默认值	取值范围
uid	true	long	母用户UID，子用户UID	NA
accessKey	false	string	API key的access key，若缺省，则返回UID对应用户的所有API key	NA

响应参数

参数名称	是否必须	数据类型	描述	取值范围
code	true	int	状态码
message	false	string	错误描述（如有）
data	true	object
[{ accessKey	true	string	access key
note	true	string	API key备注
permission	true	string	API key权限
ipAddresses	false	string	API key绑定的IP地址
validDays	true	int	API key剩余有效天数
status	true	string	API key当前状态
createTime	true	long	API key创建时间
updateTime }]	true	long	API key最近一次修改时间

修改子用户API key

POST /v2/sub-user/api-key-modification

请求参数

参数名称	是否必须	类型	描述	默认值	取值范围
subUid	true	long	子用户的uid	NA
accessKey	true	string	子用户API key的access key	NA
note	false	string	API key备注	NA	最多255位字符
permission	false	string	API key权限	NA	取值范围：readOnly、trade，其中readOnly必传，trade选传，两个间用半角逗号分隔。
ipAddresses	false	string	API key绑定的IP地址	NA	IPv4/IPv6主机地址或IPv4网络地址

响应参数

参数名称	是否必须	数据类型	描述	取值范围
code	true	int	状态码
message	false	string	错误描述（如有）
data	true	object
{ note	false	string	API key备注
permission	false	string	API key权限
ipAddresses }	false	string	API key绑定的IP地址

删除子用户API key

POST /v2/ sub-user/api-key-deletion

请求参数

参数名称	是否必须	类型	描述	默认值	取值范围
subUid	true	long	子用户的uid	NA
accessKey	true	string	子用户API key的access key	NA

响应参数

参数名称	是否必须	数据类型	描述	取值范围
code	true	int	状态码
message	false	string	错误描述（如有）

API用户需自行评估此以上接口对用户自身业务的适配，并更新相关应用。

所有变更将自本通知生效之日起更新至。

Scan QR code with WeChat

Link: 火币

Tags: 重要公告