小白开放接口

获取集合列表接口

接口链接:http://api.okayapi.com/?s=App.Main_Set.GetList

功能说明: 获取应用集合里的元素列表

容易程度:

分类标签:免费(每月最高15万次)  热门  验签

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

在线调试    添加收藏    直接访问接口    loading...


接口参数

参数名字参数类型是否必须默认值备注参数说明
sign字符串可选签名,如果不需要签名,可进入小白开放平台接口签名设置关闭或开启签名
app_key字符串必须最小:32;最大:32开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。
uuid字符串可选最小:32;最大:32UUID,全局唯一用户ID
token字符串可选最小:64;最大:64会话凭证
key字符串必须最小:1;最大:64集合名称
page整型可选1最小:1第几页
perpage整型可选10最小:1;最大:1000分页数量
sort字符串可选1最小:1;最大:6排序,1创建时间顺序,2创建时间逆序, 3权重顺序,4权重逆序,5更新时间顺序,6更新时间逆序;通过字符串拼接可组合排序,如41表示:权重逆序,创建时间顺序

返回结果 - data数据结构

返回字段类型说明
data.err_code整型操作码,0获取成功
data.err_msg字符串错误提示信息,err_code非0时参考此提示信息
data.items字符串元素列表
data.items[].id整型元素ID
data.items[].key字符串键名
data.items[].data对象条目数据
data.items[].keyword字符串关键字
data.items[].weight整型权重
data.items[].add_time字符串添加时间,格式为:Y-m-d H:i:s
data.items[].update_time字符串最后更新时间,格式为:Y-m-d H:i:s,若从未更新则为空
data.total整型元素总数
data.page整型当前第几页
data.perpage整型每页多少个

简易在线调试

service 必须
uuid 可选
token 可选
key 必须
page 可选
perpage 可选
sort 可选

客户端接入示例

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

请求:
{你的接口域名}/?s=App.Main_Set.GetList&key=students&app_key={你的app_key}&sign={动态签名}

返回:
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "items": [
            {
                "id": 65,
                "key": "students",
                "data": {
                    "username": "dogstar",
                    "age": 18
                },
                "keyword": "dogstar",
                "weight": 0,
                "add_time": "2018-07-02 23:28:21",
                "update_time": ""
            },
            {
                "id": 66,
                "key": "students",
                "data": {
                    "username": "yoyo",
                    "age": 18
                },
                "keyword": "yoyo",
                "weight": 0,
                "add_time": "2018-07-02 23:31:57",
                "update_time": ""
            }
        ],
        "total": 2,
        "page": 1,
        "perpage": 10
    },
    "msg": ""
}
<?php

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

// 调用小白开放接口
$rs = OkayApiClient::request('App.Main_Set.GetList',array('key'=>'students','app_key'=>'你的app_key'),3000);

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

/*
Array 
( 
	[ret] => 200 
	[data] => Array 
	( 
		[err_code] => 0 
		[err_msg] => 
		[items] => Array 
		( 
			[0] => Array 
			( 
				[id] => 1 
				[key] => students 
				[data] => Array 
				(
					 [id] => 65 
					 [key] => students 
					 [data] => Array 
					 ( 
					 	[username] => dogstar 
						[age] => 19 
					  ) 
					  [keyword] => dogstar 
					  [weight] => 122 
				)
				 [keyword] => 
				 [weight] => 0 
				 [add_time] => 2019-02-03 01:39:43 
				 [update_time] => 
			) 
		) 
		[total] => 1 
		[page] => 1 
		[perpage] => 10 
	) 
	
	[msg] => 小白开放接口:App.Main_Set.GetList 
)
*/

接口使用帮助说明

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

返回结果 - ret异常错误码

错误码错误类型错误描述信息解决方法
ret = 200成功请求成功
ret = 400客户端非法请求非法请求,参数错误1、根据接口文档的接口参数,提供正确的参数
ret = 401客户端非法请求用户未登录,或登录凭证已过期1、如果用户未注册,请先用注册接口;2、如果注册未登录或会话过期,请先用登录接口
ret = 404客户端非法请求接口服务不存在1、查看小白接口大全,确保接口服务名称拼写正确
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 = 500小白开放接口异常如果出现此错误,请联系技术人员处理1、进入QQ交流群897815708,反馈问题;2、或者提交工单,一天内回复

如何使用应用的三大数据?

如何选择三大数据?

热门接口

分页查询数据接口
App.Table.FreeQuery
创建新数据接口
App.Table.Create
“阅后即焚”接口(专取非重复数据)
App.Table.FreePopOne