API管理

API密钥列表

项目	内容
接口描述	API密钥列表
接口地址	/console/v1/api
请求方式	GET
接口版本	v1

请求参数

name	type	default	validate	desc
page	int	1	validate:optional	desc:页数
limit	int	10	validate:optional	desc:每页条数
orderby	string	-	idvalidate:optional	desc:排序字段
sort	string	-	ascdescvalidate:optional	desc:升降序

响应参数

name	type	default	desc
list	array	-	desc:API密钥列表
list[].name	string	-	desc:API密钥名称
list[].id	int	-	desc:API密钥ID
list[].token	string	-	desc:token
list[].create_time	int	-	desc:创建时间
list[].status	int	-	desc:白名单状态
list[].ip	string	-	desc:白名单IP
count	int	-	desc:API总数
create_api	int	-	desc:是否可创建API

创建API密钥

项目	内容
接口描述	创建API密钥
接口地址	/console/v1/api
请求方式	POST
接口版本	v1

请求参数

name	type	default	validate	desc
name	string	-	validate:required	desc:API密钥名称

响应参数

name	type	default	desc
name	string	-	desc:API密钥名称
id	int	-	desc:API密钥ID
token	string	-	desc:token
create_time	int	-	desc:创建时间
private_key	string	-	desc:私钥
api_url	string	-	desc:API接口地址

API白名单设置

项目	内容
接口描述	API白名单设置
接口地址	/console/v1/api/:id/white_list
请求方式	PUT
接口版本	v1

请求参数

name	type	default	validate	desc
id	int	-	validate:required	desc:API密钥ID
status	int	-	0关闭1开启validate:required	desc:白名单状态
ip	string	-	白名单开启时必填validate:optional	desc:白名单IP

响应参数

无

删除API密钥

项目	内容
接口描述	删除API密钥
接口地址	/console/v1/api/:id
请求方式	DELETE
接口版本	v1

请求参数

name	type	default	validate	desc
id	int	-	validate:required	desc:API密钥ID

响应参数

无