侧边栏
api用户管理接口
API用户接口
1、获取API用户列表
接口名称
/admin/apiuser/list
请求方式
post
请求参数
| 参数名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| currentpage | int | 否 | 分页数据的页码, 如不传默认是1 |
| pageSize | int | 否 | 每页返回的结果条目数，如不传入默认为10 |
返回值
| 名称 | 类型 | 说明 |
|---|---|---|
| ret | int | 获取数据状态 1:成功 0：失败 |
| retData | josn | 文章信息列表[
"dataList":[
{" id":"1",//id
" website_id":" 1",//站点id
" username":"哈哈",//名称
"ip_allow" :"2",允许的ip
" accessId":"1",//accessId
" accessKey":" sss",//accessKey
" is_backend":"",//是否是后台 1是后台
" is_app":"",//是否是App 1是
" status":"",//状态 0锁定 1正常
},{....}]
"dataPage":[
{
" currentpage" : 1 ,当前页数
" totalnum" : 27 ，总数
" pagenum" : 10 ，每页数量
}]
]
|
| code | int | 错误代码 |
2、API用户操作
接口名称
/admin/apiuser/operate
请求方式
post
请求参数
| 参数名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| id | int | 否 | 编辑的时候必填 |
| type | string | 是 | create（添加） ， update（更新） |
| username | string | 是 | 用户名 |
| website_id | intval | 是 | 站点id |
| is_backend | string | 是 | 是否是后台 |
| is_app | string | 是 | 是否是app |
| status | intval | 是 | 状态 0锁定 1正常 |
返回值
| 名称 | 类型 | 说明 |
|---|---|---|
| ret | int | 获取数据状态 1:成功 0：失败 |
| retMsg | string | 操作 |
| code | int | 错误代码 |
3、API用户删除
接口名称
/admin/apiuser/delete
请求方式
post
请求参数
| 参数名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| id | int | 是 | API用户id |
返回值
| 名称 | 类型 | 说明 |
|---|---|---|
| ret | int | 获取数据状态 1:成功 0：失败 |
| retMsg | string | 操作 |
| code | int | 错误代码 |
4、API用户状态
接口名称
/admin/apiuser/status
请求方式
post
请求参数
| 参数名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| id | int | 是 | API用户id |
| type | string | 是 | start（开启） ， stop（停用） |
返回值
| 名称 | 类型 | 说明 |
|---|---|---|
| ret | int | 获取数据状态 1:成功 0：失败 |
| retMsg | string | 操作 |
| code | int | 错误代码 |
5、重置ＡＰＩ用的key
接口名称
/admin/apiuser/resetAccessKey
请求方式
post
请求参数
| 参数名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| id | int | 是 | API用户id |
返回值
| 名称 | 类型 | 说明 |
|---|---|---|
| ret | int | 获取数据状态 1:成功 0：失败 |
| retMsg | string | 操作 |
| code | int | 错误代码 |
6、获取API用户详情
接口名称
/admin/apiuser/show
请求方式
post
请求参数
| 参数名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| id | int | 是 | API用户id |
返回值
| 名称 | 类型 | 说明 |
|---|---|---|
| ret | int | 获取数据状态 1:成功 0：失败 |
| retData | josn | 文章信息{" id":"1",//id
" website_id":" 1",//站点id
" username":"哈哈",//名称
"ip_allow" :"2",允许的ip
" accessId":"1",//accessId
" accessKey":" sss",//accessKey
" is_backend":"",//是否是后台 1是后台
" is_app":"",//是否是App 1是
" status":"",//状态 0锁定 1正常
}
|
| code | int | 错误代码 |
api用户管理接口.txt · 最后更改: 2017/06/01 13:59 (外部编辑)
除额外注明的地方外，本维基上的内容按下列许可协议发布： CC Attribution-Share Alike 3.0 Unported
