果创云开放接口

02013 获取会员列表接口

接口地址:http://api.yesapi.cn/?s=App.User.GetList

接口描述: 获取已注册的会员列表

接口标签:免费(每月最高10万次)付费(包月/按量/私服)验签

请求协议
HTTP/HTTPS
请求方式
GET/POST(推荐POST)
编码格式
UTF-8
返回格式
JSON

在线测试    添加收藏    直接访问接口


接口参数

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。
sign字符串可选动态签名,签名生成算法请见:如何生成签名,或直接使用封装好的SDK开发包
如果不需要签名,可进入小白开放平台接口签名设置关闭或开启签名。通过在线测试工具可进行签名的对比和调试。 企业版支持专属签名算法定制。
uuid字符串可选最大:32UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。
token字符串可选最小:64;最大:64当前登录会员的会话凭证,可通过会员登录接口获得。
page整型可选1第几页
perpage整型可选20最大:1000分页数量
role字符串可选all管理员为"admin"用户为"user"全部为"all"
sort_type整型可选11注册时间降序,2注册时间升序,3账号名降序,4账号名升序

在线测试

参数是否必填
s 必须
uuid 可选
token 可选
page 可选
perpage 可选
role 可选
sort_type 可选

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

请求:
{你的接口域名}/?s=App.User.GetList&page=1&perpage=20&app_key={你的app_key}&sign={动态签名}

返回:
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "users": [
            {
                "uuid": "D1B17A85D3D0A38606359115BD01EFEC",
                "username": "dogstar",
                "role": "admin",
                "role_desc": "管理员",
                "status": 0,
                "status_desc": "正常",
                "reg_time": "2018-06-28 22:03:22",
                "ext_info": {
                }
            },
            {
                "uuid": "6C227C5775E547105BBD3D49756C850A",
                "username": "test",
                "role": "user",
                "role_desc": "普通会员",
                "status": 1,
                "status_desc": "已封号",
                "reg_time": "2017-11-10 22:39:15",
                "ext_info": {
                    "nickname": "dogstar",
                    "age": 19,
                    "location": "广州"
                }
            }
        ],
        "total": 2
    },
    "msg": "当前请求接口:App.User.GetList"
}
<?php

// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';

// 调用小白开放接口
$rs = OkayApiClient::request('App.User.GetList');

// 输出结果
print_r($rs);

/*
Array 
( 
	[ret] => 200 
	[data] => Array 
	( 
		[err_code] => 0 
		[err_msg] => 
		[users] => Array 
		( 
			[0] => Array 
				( 
					[uuid] => E7FA3ED38345FBD3367711E61FE4E2FC 
					[username] => 小白 
					[role] => user 
					[role_desc] => 管理员 
					[status] => 0 
					[status_desc] => 正常 
					[reg_time] => 2019-02-02 22:24:18 
					[ext_info] => Array ( )
				) 
			[1] =>Array 
				( 
					[uuid] => 5DDC99652BE5C698411400CC693802A1 
					[username] => AAA 
					[role] => user 
					[role_desc] => 普通用户 
					[status] => 0 
					[status_desc] => 正常 
					[reg_time] => 2019-02-02 20:00:00 
					[ext_info] => Array ( ) 
				) 
			[2] =>Array 
				( 
					[uuid] => A5EA893548E493A0ABD6F64978AAA773 
					[username] => 123123 
					[role] => user 
					[role_desc] => 普通用户 
					[status] => 0 
					[status_desc] => 正常 
					[reg_time] => 2019-02-02 17:35:59 
					[ext_info] => Array ( )
				) 
		) 
		[total] => 3
	) 
	
	[msg] => 小白开放接口:App.User.GetList 
)
*/

接口使用帮助说明

小白君正在拼命补充中……

返回结构说明

返回字段类型说明
ret整型接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码
data.err_code整型操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景
data.err_msg字符串错误提示信息,err_code非0时参考此提示信息
data.users字符串会员列表
data.users[].uuid字符串会员UUID
data.users[].username字符串会员账号
data.users[].role字符串会员角色,admin是管理员,user是普通用户
data.users[].role_desc字符串会员角色说明
data.users[].status整型会员状态,0正常,1已被封号
data.users[].status_desc字符串会员状态说明
data.users[].reg_time字符串注册时间
data.users[].ext_info对象通过修改用户扩展信息接口修改的特定会员扩展信息,通过默认会员扩展信息配置可以设置默认扩展信息。
data.total整型会员总数
msg字符串提示信息,面向技术人员的帮助或错误提示信息

ret异常错误码

错误码错误类型错误描述信息解决方法
ret = 200成功请求成功
ret = 400客户端非法请求非法请求,参数错误1、根据接口文档的接口参数,提供正确的参数
ret = 404客户端非法请求接口服务不存在1、查看小白接口大全,确保接口服务名称拼写正确
ret = 500果创云开放接口异常如果出现此错误,请联系技术人员处理1、进入QQ交流群897815708,反馈问题;2、或者提交工单,一天内回复
ret = 401客户端非法请求用户未登录,或登录凭证已过期1、如果用户未注册,请先用注册接口;2、如果注册未登录或会话过期,请先用登录接口
ret = 406客户端非法请求非法app_key,请核对你所在的接口域名1、在我的套餐查看并核对接口域名
ret = 407客户端非法请求当前应用已过期1、进行续费或续约,延长应用有效期
ret = 408客户端非法请求当前应用存在异常,已被封号1、联系在线客服人工处理
ret = 409客户端非法请求签名错误1、使用在线测试,校正签名;2、关闭特定或全部签名设置;3、如果过期,可以进行续约/升级
ret = 410客户端非法请求权限不足,非系统管理员1、应用权限不足,可联系在线客服咨询沟通
ret = 411客户端非法请求权限不足,应用管理员未登录1、请提供应用管理员的admin_uuid和admin_token参数后重试
ret = 412客户端非法请求权限不足,非应用管理员1、请在果创云开放平台把会员设置为管理员
ret = 413客户端非法请求本月接口流量超出,已被临时冻结1、开通接口流量叠加包,或升级套餐
ret = 414客户端非法请求并发过高1、请降低请求频率,检测是否有死循环调用,或是否被他人恶意使用。如果流量确实很大,可联系在线客服进行定制化或私有云部署。
ret = 415客户端非法请求接口已被开发者关闭1、接口已被开发者关闭,请进入果创云开放平台接口开关重新开启
ret = 416客户端非法请求权限不足,个人免费版套餐无法使用专业版接口1、请先升级终身会员/标准版/旗舰版/企业版

常见问题FAQ

Q1 问:出现 414 Request-URI Too Large 时怎么解决?答:对于全部参数,改用POST方式传递,并且从GET链接里面去掉。