小白开放接口

[多合一] 智能刷新接口

接口地址:http://api.okayapi.com/?s=App.Partner_Counter.SmartRefresh

接口描述: 当计数器时,执行更新操作;当计数器不存在时,执行创建并初始化,初始的默认值为0,最小值为0,最大值为9,999,999,999,可见性为public。相当于Setup和Update接口的组合,简化客户端使用

接口标签:免费  验签  登录

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

在线测试    添加收藏    直接访问接口    阅读:加载中...


接口参数

参数名字参数类型是否必须默认值备注参数说明
sign字符串可选动态签名,签名生成算法请见:如何生成签名,或直接使用封装好的SDK开发包。如果不需要签名,可进入小白开放平台接口签名设置关闭或开启签名。通过在线测试工具可进行签名的对比和调试。
app_key字符串必须最小:32;最大:32开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。
uuid字符串必须最小:32;最大:32UUID,全局唯一用户ID
token字符串必须最小:64;最大:64会话凭证
type枚举类型必须范围:hour/day/week/month/year/forever计数器类型,时/日/周/月/年/永久计数器
name字符串必须最小:1;最大:64计数器名称
other_uuid字符串必须最小:32;最大:32已登录用户针对的其他用户的ID
value整型必须1待增量更新的值,为正数时增加,为负数则减少

返回结构说明

返回字段类型说明
ret整型接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码
data.err_code整型状态操作码,0成功,1计数器不存在
data.err_msg字符串错误提示信息,err_code非0时参考此提示信息
data.before_value整型更新前原来的值
data.after_value整型更新后的值
msg字符串提示信息,面向技术人员的帮助或错误提示信息

在线测试

参数是否必填
s 必须
uuid 必须
token 必须
type 必须
name 必须
other_uuid 必须
value 必须

客户端请求示例

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

请求:
{你的接口域名}/?s=App.Partner_Counter.SmartRefresh&type=day&name=visit_times&value=1&app_key={你的app_key}&sign={动态签名}

返回:
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "before_value": 6,
        "after_value": 7
    },
    "msg": ""
}
<?php

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

// 当计数器已存在时,调用小白开放接口
$uuid='E7FA3ED38345FBD3367711E61FE4E2FC';
$token='66493A11E1EB97BA438023527F93CFB35AABBF5DB0386F1EBCF76266080B13A7';
$other_uuid='5DDC99652BE5C698411400CC693802A1';
$rs = OkayApiClient::request('App.Partner_Counter.SmartRefresh',array('uuid'=>$uuid,'token'=>$token,'other_uuid'=>$other_uuid,'type'=>'day','name'=>'visit_times'));

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

/*
Array 
( 
	[ret] => 200 
	[data] => Array 
	( 
		[err_code] => 0 
		[err_msg] => 
		[before_value] => 3 
		[after_value] => 4
	 ) 
	 [msg] => 小白开放接口:App.Partner_Counter.SmartRefresh 
)
*/


<?php

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

// 当计数器不存在时,调用小白开放接口
$uuid='E7FA3ED38345FBD3367711E61FE4E2FC';
$token='66493A11E1EB97BA438023527F93CFB35AABBF5DB0386F1EBCF76266080B13A7';
$other_uuid='A5EA893548E493A0ABD6F64978AAA773';
$rs = OkayApiClient::request('App.Partner_Counter.SmartRefresh',array('uuid'=>$uuid,'token'=>$token,'other_uuid'=>$other_uuid,'type'=>'day','name'=>'visit_times'));

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

/*
Array 
( 
	[ret] => 200 
	[data] => Array 
	( 
		[err_code] => 0 
		[err_msg] => 
		[before_value] => 0 
		[after_value] => 1 
	) 
	[msg] => 小白开放接口:App.Partner_Counter.SmartRefresh 
)
*/

接口使用帮助说明

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

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 = 415客户端非法请求接口已被开发者关闭1、接口已被开发者关闭,请进入小白开放平台接口开关重新开启
ret = 500小白开放接口异常如果出现此错误,请联系技术人员处理1、进入QQ交流群897815708,反馈问题;2、或者提交工单,一天内回复

猜你喜欢