YesApi 接口文档

5401 设定计数器

接口路径(新)：http://hn216.api.okayapi.com/api/App/Guest_Counter/Setup

接口路径(旧)：http://hn216.api.okayapi.com/?s=App.Guest_Counter.Setup

接口描述： 增 游客对用户的计数器进行初始化，进行最值、起始值等设定

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选最小：32；最大：32UUID，全局唯一用户ID
token字符串可选最小：64；最大：64会话凭证
return_data字符串可选0公共参数 数据返回结构，其中：
  • return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；
  • return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
type枚举类型必须范围：hour/day/week/month/year/forever计数器类型，时/日/周/月/年/永久计数器
name字符串必须最小：1；最大：64计数器名称
other_uuid字符串必须最小：32；最大：32游客针对的UUID，全局唯一用户ID
value整型必须0设定的起始值
min整型可选0计数器的最小值
max整型可选9999999999计数器的最大值
visiable枚举类型可选public范围：private/protected/public可见性，private为私有的，protected为受保护的，public为开放的

客户端请求示例

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

HTTP通用示例PHP示例 
请求：
{你的接口域名}/?s=App.Guest_Counter.Setup&type=day&name=visit_times&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": ""
    },
    "msg": ""
}
<?php

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

// 调用小白开放接口
$uuid='E7FA3ED38345FBD3367711E61FE4E2FC';
$token='66493A11E1EB97BA438023527F93CFB35AABBF5DB0386F1EBCF76266080B13A7';
$other_uuid='E2FA6B2608CE3C1312EBAF389584C4C5';
$rs = OkayApiClient::request('App.Guest_Counter.Setup',array('uuid'=>$uuid,'token'=>$token,'type'=>'day','name'=>'visit_times','other_uuid'=>$other_uuid));

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

/*
Array 
( 
	[ret] => 200 
	[data] => Array 
	( 
		[err_code] => 0 
		[err_msg] => 
	) 
	[msg] => 小白开放接口：App.Guest_Counter.Setup 
)
*/

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_code整型状态操作码，0成功，1计数器已存在
data.err_msg字符串错误提示信息，err_code非0时参考此提示信息
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单
YesApi 接口文档

5402 增量更新计数器

接口路径(新)：http://hn216.api.okayapi.com/api/App/Guest_Counter/Update

接口路径(旧)：http://hn216.api.okayapi.com/?s=App.Guest_Counter.Update

接口描述： 改 游客可以增量更新用户的日/周/月/年计数器，可增加/减少，value为正数增加，为负数则减少。

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选最小：32；最大：32UUID，全局唯一用户ID
token字符串可选最小：64；最大：64会话凭证
return_data字符串可选0公共参数 数据返回结构，其中：
  • return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；
  • return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
type枚举类型必须范围：hour/day/week/month/year/forever计数器类型，时/日/周/月/年/永久计数器
name字符串必须最小：1；最大：64计数器名称
other_uuid字符串必须最小：32；最大：32游客针对的UUID，全局唯一用户ID
value整型必须1待增量更新的值，为正数时增加，为负数则减少

客户端请求示例

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

HTTP通用示例PHP示例 
请求：
{你的接口域名}/?s=App.Guest_Counter.Update&type=day&name=visit_times&value=1&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "before_value": 2,
        "after_value": 3,
        "add_value": 1,
        "value": 1
    },
    "msg": ""
}
<?php

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

// 调用小白开放接口
$uuid='E7FA3ED38345FBD3367711E61FE4E2FC';
$token='66493A11E1EB97BA438023527F93CFB35AABBF5DB0386F1EBCF76266080B13A7';
$other_uuid='E2FA6B2608CE3C1312EBAF389584C4C5';
$rs = OkayApiClient::request('App.Guest_Counter.Update',array('uuid'=>$uuid,'token'=>$token,'other_uuid'=>$other_uuid,'type'=>'day','name'=>'visit_times','value'=>3));

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


/*
Array 
( 
	[ret] => 200 
	[data] => Array 
	( 
		[err_code] => 0 
		[err_msg] => 
		[before_value] => 0 
		[after_value] => 3 
		[add_value] => 3 
		[value] => 3 
	) 
	[msg] => 小白开放接口：App.Guest_Counter.Update 
)
*/

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_code整型状态操作码，0成功，1计数器不存在
data.err_msg字符串错误提示信息，err_code非0时参考此提示信息
data.before_value整型更新前原来的值
data.after_value整型更新后的值
data.add_value整型服务端实际累加的值（尽可能累加的值，即在不超出最值的情况下尽最大可能累加的值）
data.value整型客户端期望累加的值
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单
YesApi 接口文档

5403 获取计数器

接口路径(新)：http://hn216.api.okayapi.com/api/App/Guest_Counter/Get

接口路径(旧)：http://hn216.api.okayapi.com/?s=App.Guest_Counter.Get

接口描述： 查 游客获取用户的计数器的值

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选最小：32；最大：32UUID，全局唯一用户ID
token字符串可选最小：64；最大：64会话凭证
return_data字符串可选0公共参数 数据返回结构，其中：
  • return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；
  • return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
type枚举类型必须范围：hour/day/week/month/year/forever计数器类型，时/日/周/月/年/永久计数器
name字符串必须最小：1；最大：64计数器名称
other_uuid字符串必须最小：32；最大：32游客针对的UUID，全局唯一用户ID
time字符串可选手动指定需要查询的时间，根据计数器的类型不同，每种类型的时间格式分别是：
  • 时：YmdH，例如：2020010100，即：年月日小时
  • 日：Ymd，例如：20200101，即：年月日
  • 周：YW，例如：202042，即：年周
  • 月：Ym，例如：202001，即：年月
  • 年：Y，例如：2020，即：年
  • 永久：forever，固定为forever

不传时，系统自动获取当时对应的时间。

客户端请求示例

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

HTTP通用示例PHP示例 
请求：
{你的接口域名}/?s=App.Guest_Counter.Get&type=day&name=visit_times&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "value": 3
    },
    "msg": ""
}
<?php

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

// 调用小白开放接口
$other_uuid='E2FA6B2608CE3C1312EBAF389584C4C5';
$rs = OkayApiClient::request('App.Guest_Counter.Get',array('other_uuid'=>$other_uuid,'type'=>'day','name'=>'visit_times'));

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

/*
Array 
( 
	[ret] => 200 
	[data] => Array 
	( 
		[err_code] => 0 
		[err_msg] => 
		[value] => 0 
	) 
	[msg] => 小白开放接口：App.Guest_Counter.Get 
)
*/

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_code整型状态操作码，0成功，1计数器不存在
data.err_msg字符串错误提示信息，err_code非0时参考此提示信息
data.value整型计数器的值
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单
YesApi 接口文档

9003 [多合一] 智能刷新接口

接口路径(新)：http://hn216.api.okayapi.com/api/App/Guest_Counter/SmartRefresh

接口路径(旧)：http://hn216.api.okayapi.com/?s=App.Guest_Counter.SmartRefresh

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

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选最小：32；最大：32UUID，全局唯一用户ID
token字符串可选最小：64；最大：64会话凭证
return_data字符串可选0公共参数 数据返回结构，其中：
  • return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；
  • return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
type枚举类型必须范围：hour/day/week/month/year/forever计数器类型，时/日/周/月/年/永久计数器
name字符串必须最小：1；最大：64计数器名称
other_uuid字符串必须最小：32；最大：32游客针对的UUID，全局唯一用户ID
value整型必须1待增量更新的值，为正数时增加，为负数则减少

客户端请求示例

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

HTTP通用示例PHP示例 
请求：
{你的接口域名}/?s=App.Guest_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='E2FA6B2608CE3C1312EBAF389584C4C5';
$rs = OkayApiClient::request('App.Guest_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.Guest_Counter.SmartRefresh 
)
*/

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_code整型状态操作码，0成功，1计数器不存在
data.err_msg字符串错误提示信息，err_code非0时参考此提示信息
data.before_value整型更新前原来的值
data.after_value整型更新后的值
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单
YesApi 接口文档

9005 获取当前计数器排行榜

接口路径(新)：http://hn216.api.okayapi.com/api/App/Guest_Counter/RankList

接口路径(旧)：http://hn216.api.okayapi.com/?s=App.Guest_Counter.RankList

接口描述： 根据不同的计数器类型，获取当前周期的排行榜。例如小时的日排行榜、日的月排行榜、周的年排行榜、月的年排行榜、年的全部排序榜、永久的永久排行榜。向上一级取更大时间范围的排行榜。

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选最小：32；最大：32UUID，全局唯一用户ID
token字符串可选最小：64；最大：64会话凭证
return_data字符串可选0公共参数 数据返回结构，其中：
  • return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；
  • return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
type枚举类型必须范围：hour/day/week/month/year/forever计数器类型，时/日/周/月/年/永久计数器
name字符串可选最小：1；最大：64计数器名称，支持模糊匹配，为空时取全部
other_uuid字符串必须最小：32；最大：32游客针对的UUID，全局唯一用户ID
num整型可选100排行榜前面多少个
start_time字符串可选开始时间，未指定时取当前相应的时间周期，示例：2020-05-14 14:29:12

客户端请求示例

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

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_code整型操作码，0表示成功，正数表示业务失败场景，负数表示系统失败场景
data.err_msg字符串错误提示信息，err_code非0时参考此提示信息
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

特别注意：当前 hn216.api.okayapi.com 为临时接口测试域名！请先完成 绑定独立接口域名后 ，才能正式进行API调用。

由 果创云YesApi.cn 提供技术支持，4万+开发者都在用，累计API调用1,800,000＋万次