YesApi 接口文档

5701 设定计数器接口

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

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

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

API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
uuidStringOptaionMIN: 32；MAX: 32UUID，全局唯一用户ID
tokenStringOptaionMIN: 64；MAX: 64会话凭证
typeEnumRequiredRange: hour/day/week/month/year/forever计数器类型，时/日/周/月/年/永久计数器
nameStringRequiredMIN: 1；MAX: 64计数器名称
valueIntRequired0设定的起始值
minIntOptaion0计数器的最小值
maxIntOptaion9999999999计数器的最大值

API Usage Demo

HTTPPHP 
请求：
{OKAYAPI_API_HOST}/?s=App.Main_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.Main_Counter.Setup',array('uuid'=>$uuid,'token'=>$token,'type'=>'day','name'=>'visit_times','value'=>0));

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

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

API Response

KEYTypeDescription
err_codeInt状态操作码，0成功，1计数器已存在
err_msgString错误提示信息，err_code非0时参考此提示信息
YesApi 接口文档

5702 增量更新计数器接口

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

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

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

API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
uuidStringOptaionMIN: 32；MAX: 32UUID，全局唯一用户ID
tokenStringOptaionMIN: 64；MAX: 64会话凭证
typeEnumRequiredRange: hour/day/week/month/year/forever计数器类型，时/日/周/月/年/永久计数器
nameStringRequiredMIN: 1；MAX: 64计数器名称
valueIntRequired1待增量更新的值，为正数时增加，为负数则减少

API Usage Demo

HTTPPHP 
请求：
{OKAYAPI_API_HOST}/?s=App.Main_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';

// 调用小白开放接口
$rs = OkayApiClient::request('App.Main_Counter.Update',array('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.Main_Counter.Update 
 )
*/

API Response

KEYTypeDescription
err_codeInt状态操作码，0成功，1计数器不存在
err_msgString错误提示信息，err_code非0时参考此提示信息
before_valueInt更新前原来的值
after_valueInt更新后的值
add_valueInt服务端实际累加的值（尽可能累加的值，即在不超出最值的情况下尽最大可能累加的值）
valueInt客户端期望累加的值
YesApi 接口文档

5703 获取计数器接口

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

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

接口描述： 查 获取计数器的值

API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
uuidStringOptaionMIN: 32；MAX: 32UUID，全局唯一用户ID
tokenStringOptaionMIN: 64；MAX: 64会话凭证
typeEnumRequiredRange: hour/day/week/month/year/forever计数器类型，时/日/周/月/年/永久计数器
nameStringRequiredMIN: 1；MAX: 64计数器名称
timeStringOptaion手动指定需要查询的时间，根据计数器的类型不同，每种类型的时间格式分别是：
  • 时：YmdH，例如：2020010100，即：年月日小时
  • 日：Ymd，例如：20200101，即：年月日
  • 周：YW，例如：202042，即：年周
  • 月：Ym，例如：202001，即：年月
  • 年：Y，例如：2020，即：年
  • 永久：forever，固定为forever

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

API Usage Demo

HTTPPHP 
请求：
{OKAYAPI_API_HOST}/?s=App.Main_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.Main_Counter.Get',array('uuid'=>$uuid,'token'=>$token,'type'=>'day','name'=>'visit_times'));

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

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

API Response

KEYTypeDescription
err_codeInt状态操作码，0成功，1计数器不存在
err_msgString错误提示信息，err_code非0时参考此提示信息
valueInt计数器的值
YesApi 接口文档

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

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

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

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

API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
uuidStringOptaionMIN: 32；MAX: 32UUID，全局唯一用户ID
tokenStringOptaionMIN: 64；MAX: 64会话凭证
typeEnumRequiredRange: hour/day/week/month/year/forever计数器类型，时/日/周/月/年/永久计数器
nameStringRequiredMIN: 1；MAX: 64计数器名称
valueIntRequired1待增量更新的值，为正数时增加，为负数则减少

API Usage Demo

HTTPPHP 
请求：
{OKAYAPI_API_HOST}/?s=App.Main_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';

// 调用小白开放接口
$rs = OkayApiClient::request('App.Main_Counter.SmartRefresh',array('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.Main_Counter.SmartRefresh 
)
*/

API Response

KEYTypeDescription
err_codeInt状态操作码，0成功，1计数器不存在
err_msgString错误提示信息，err_code非0时参考此提示信息
before_valueInt更新前原来的值
after_valueInt更新后的值
YesApi 接口文档

9005 获取当前计数器排行榜

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

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

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

API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
uuidStringOptaionMIN: 32；MAX: 32UUID，全局唯一用户ID
tokenStringOptaionMIN: 64；MAX: 64会话凭证
typeEnumRequiredRange: hour/day/week/month/year/forever计数器类型，时/日/周/月/年/永久计数器
nameStringOptaionMIN: 1；MAX: 64计数器名称，支持模糊匹配，为空时取全部
numIntOptaion100排行榜前面多少个
start_timeStringOptaion开始时间，未指定时取当前相应的时间周期，示例：2020-05-14 14:29:12

API Usage Demo

HTTP 
请求：
{OKAYAPI_API_HOST}/?s=App.Main_Counter.RankList&type=day&num=100&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "list": [
        {
            "counter_name": "test_main",
            "counter_value": 9,
            "counter_prefix": "20200518",
            "counter_type": "day",
            "add_time": "2020-05-18 10:29:13"
        },
        {
            "counter_name": "test_main",
            "counter_value": 6,
            "counter_prefix": "20200501",
            "counter_type": "day",
            "add_time": "2020-05-01 17:09:31"
        },
        {
            "counter_name": "test_main",
            "counter_value": 6,
            "counter_prefix": "20200511",
            "counter_type": "day",
            "add_time": "2020-05-11 09:31:16"
        },
        {
            "counter_name": "test_main",
            "counter_value": 6,
            "counter_prefix": "20200513",
            "counter_type": "day",
            "add_time": "2020-05-13 14:41:15"
        },
        {
            "counter_name": "test_main",
            "counter_value": 6,
            "counter_prefix": "20200514",
            "counter_type": "day",
            "add_time": "2020-05-14 14:29:12"
        }
        ]
    },
    "msg": "V2.1.1 YesApi App.Main_Counter.RankList"
}

API Response

KEYTypeDescription
err_codeInt操作码，0表示成功，正数表示业务失败场景，负数表示系统失败场景
err_msgString错误提示信息，err_code非0时参考此提示信息

Power by OkayAPI.com Contact us (WA: okayapi OR Email: chanzonghuang@gmail.com).
Timezone: America/New_York Jul/01/2025 21:37:00