接口路径(新):http://api.okayapi.com/api/App/User_Counter/Setup
接口路径(旧):http://api.okayapi.com/?s=App.User_Counter.Setup
接口描述: 增 对计数器进行初始化,进行最值、起始值等设定
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
uuid | String | Required | MIN: 32;MAX: 32 | UUID,全局唯一用户ID | |
token | String | Required | MIN: 64;MAX: 64 | 会话凭证 | |
type | Enum | Required | Range: hour/day/week/month/year/forever | 计数器类型,时/日/周/月/年/永久计数器 | |
name | String | Required | MIN: 1;MAX: 64 | 计数器名称 | |
value | Int | Required | 0 | 设定的起始值 | |
min | Int | Optaion | 0 | 计数器的最小值 | |
max | Int | Optaion | 9999999999 | 计数器的最大值 | |
visiable | Enum | Optaion | private | Range: private/protected/public | 可见性,private为私有的,protected为受保护的,public为开放的 |
请求:
{OKAYAPI_API_HOST}/?s=App.User_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';
$rs = OkayApiClient::request('App.User_Counter.Setup',array('uuid'=>$uuid,'token'=>$token,'type'=>'day','name'=>'visit_times'));
// 输出结果
print_r($rs);
/*
Array
(
[ret] => 200
[data] => Array
(
[err_code] => 0
[err_msg] =>
)
[msg] => 小白开放接口:App.User_Counter.Setup
)
*/
KEY | Type | Description |
---|---|---|
err_code | Int | 状态操作码,0成功,1计数器已存在 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
接口路径(新):http://api.okayapi.com/api/App/User_Counter/Update
接口路径(旧):http://api.okayapi.com/?s=App.User_Counter.Update
接口描述: 改 可以增量更新日/周/月/年计数器,可增加/减少,value为正数增加,为负数则减少。
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
uuid | String | Required | MIN: 32;MAX: 32 | UUID,全局唯一用户ID | |
token | String | Required | MIN: 64;MAX: 64 | 会话凭证 | |
type | Enum | Required | Range: hour/day/week/month/year/forever | 计数器类型,时/日/周/月/年/永久计数器 | |
name | String | Required | MIN: 1;MAX: 64 | 计数器名称 | |
value | Int | Required | 1 | 待增量更新的值,为正数时增加,为负数则减少 |
请求:
{OKAYAPI_API_HOST}/?s=App.User_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';
$rs = OkayApiClient::request('App.User_Counter.Update',array('uuid'=>$uuid,'token'=>$token,'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.User_Counter.Update
)
*/
KEY | Type | Description |
---|---|---|
err_code | Int | 状态操作码,0成功,1计数器不存在 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
before_value | Int | 更新前原来的值 |
after_value | Int | 更新后的值 |
add_value | Int | 服务端实际累加的值(尽可能累加的值,即在不超出最值的情况下尽最大可能累加的值) |
value | Int | 客户端期望累加的值 |
接口路径(新):http://api.okayapi.com/api/App/User_Counter/SmartRefresh
接口路径(旧):http://api.okayapi.com/?s=App.User_Counter.SmartRefresh
接口描述: 增改 当计数器时,执行更新操作;当计数器不存在时,执行创建并初始化,初始的默认值为0,最小值为0,最大值为9,999,999,999,可见性为public。相当于Setup和Update接口的组合,简化客户端使用
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
uuid | String | Required | MIN: 32;MAX: 32 | UUID,全局唯一用户ID | |
token | String | Required | MIN: 64;MAX: 64 | 会话凭证 | |
type | Enum | Required | Range: hour/day/week/month/year/forever | 计数器类型,时/日/周/月/年/永久计数器 | |
name | String | Required | MIN: 1;MAX: 64 | 计数器名称 | |
value | Int | Required | 1 | 待增量更新的值,为正数时增加,为负数则减少 |
请求:
{OKAYAPI_API_HOST}/?s=App.User_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';
$rs = OkayApiClient::request('App.User_Counter.SmartRefresh',array('uuid'=>$uuid,'token'=>$token,'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.User_Counter.SmartRefresh
)*/
KEY | Type | Description |
---|---|---|
err_code | Int | 状态操作码,0成功,1计数器不存在 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
before_value | Int | 更新前原来的值 |
after_value | Int | 更新后的值 |
接口路径(新):http://api.okayapi.com/api/App/User_Counter/Get
接口路径(旧):http://api.okayapi.com/?s=App.User_Counter.Get
接口描述: 查 获取计数器的值
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
uuid | String | Required | MIN: 32;MAX: 32 | UUID,全局唯一用户ID | |
token | String | Required | MIN: 64;MAX: 64 | 会话凭证 | |
type | Enum | Required | Range: hour/day/week/month/year/forever | 计数器类型,时/日/周/月/年/永久计数器 | |
name | String | Required | MIN: 1;MAX: 64 | 计数器名称 | |
time | String | Optaion | 手动指定需要查询的时间,根据计数器的类型不同,每种类型的时间格式分别是:
不传时,系统自动获取当时对应的时间。 |
请求:
{OKAYAPI_API_HOST}/?s=App.User_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';
// 调用小白开放接口
$uuid='E7FA3ED38345FBD3367711E61FE4E2FC';
$token='66493A11E1EB97BA438023527F93CFB35AABBF5DB0386F1EBCF76266080B13A7';
$rs = OkayApiClient::request('App.User_Counter.Get',array('uuid'=>$uuid,'token'=>$token,'type'=>'day','name'=>'visit_times'));
// 输出结果
print_r($rs);
/*
Array
(
[ret] => 200
[data] => Array
(
[err_code] => 0
[err_msg] =>
[value] => 0
)
[msg] => 小白开放接口:App.User_Counter.Get
)
*/
KEY | Type | Description |
---|---|---|
err_code | Int | 状态操作码,0成功,1计数器不存在 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
value | Int | 计数器的值 |
接口路径(新):http://api.okayapi.com/api/App/User_Counter/RankList
接口路径(旧):http://api.okayapi.com/?s=App.User_Counter.RankList
接口描述: 根据不同的计数器类型,获取当前周期的排行榜。例如小时的日排行榜、日的月排行榜、周的年排行榜、月的年排行榜、年的全部排序榜、永久的永久排行榜。向上一级取更大时间范围的排行榜。
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
uuid | String | Required | MIN: 32;MAX: 32 | UUID,全局唯一用户ID | |
token | String | Required | MIN: 64;MAX: 64 | 会话凭证 | |
type | Enum | Required | Range: hour/day/week/month/year/forever | 计数器类型,时/日/周/月/年/永久计数器 | |
name | String | Optaion | MIN: 1;MAX: 64 | 计数器名称,支持模糊匹配,为空时取全部 | |
num | Int | Optaion | 100 | 排行榜前面多少个 | |
start_time | String | Optaion | 开始时间,未指定时取当前相应的时间周期,示例:2020-05-14 14:29:12 |
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
Power by OkayAPI.com Contact us (WA: okayapi OR Email: chanzonghuang@gmail.com).
Timezone: America/New_York May/02/2024 17:32:22