• 小白接口
  • 我的
    • 我的API(云函数,由开发者开发)
    • 私人定制API(由平台开发)
    • API接口测试
    • API接口设计
    • 免费接口文档
  • 应用
    • 会员模块 重要
    • 配置模块
    • 数据统计模块
    • 日志模块
    • CDN图片文件模块
    • 邮件服务模块
    • 图形验证码模块
    • 微信集成模块
    • 短信模块
    • 短链接模块
    • 七牛云API 新
    • 阿里云OSS存储API 新
    • 快递100API 新
    • 微信小程序API 新
    • 阿里云短信API 新
    • 抖音开放平台API 新
    • 淘宝客开放平台API 新
    • 若需要接入其他开放平台,请告诉我们 ^_^
  • 数据库
    • 模型数据接口 [通用版] 开发必备
    • 模型结构API
    • 三大基础数据
    • 应用元数据模块
    • 应用集合数据模块
    • 应用计数器模块
    • 程序化数据API
    • MySQL API [直连版]
    • Redis API [直连版]
    • Sql Server API [直连版]
  • 小程序
    • 微信小程序API-用户模块
    • 微信小程序API-CMS文章内容
    • 微信小程序API-商品模块
    • 微信小程序API-首页轮播图
    • 微信小程序API-公告
    • 微信小程序API-首页菜单
    • 微信小程序API-小程序码
    • 微信小程序API-上传图片
    • 微信小程序API-发送微信模板消息接口
    • 微信小程序API-上传文件
    • 微信小程序API-订单与支付
    • 微信小程序API-更多接口
    • 微信小程序API-后台接口
    • JS SDK 新
    • 微信小程序示例 新
    • 在线生成微信小程序代码 新
  • 实用
    • 二维码模块
    • 条形码模块
    • 会员头像模块
    • IP服务模块
    • 拼音模块
    • 全国地址API
    • 全国大学API
    • 昵称API
    • 密码API
    • 模拟数据API
    • 身份证号码API
    • 手机号归属地API
    • 日期API
    • 笑话API
    • 唯一ID生成API
    • 快递API
    • 查询天气API
    • 查询单词API
    • 加解密API
    • JWT认证授权API
    • 中文分词API
    • 简繁体转换API
    • 周公解梦API
  • 插件
    • 微信联登标准接口 火
    • 会员收货地址接口 新
    • 好友标准接口 新
    • 私信标准接口 新
    • 评论/留言板标准接口
    • 收藏夹标准接口
    • 首页广告标准接口
    • 带纪录的邮件标准接口
    • 日历公告标准接口
    • 调查问卷标准接口
    • 联系我们标准接口
    • 迷你朋友圈标准接口
    • 超级日志标准接口
    • 签到接口
    • 时间卡密接口
    • 数量卡密接口
    • 简易动态解析接口新
    • 在线统计接口新
    • 在线客服接口新
    • 用户权限分配接口新
  • 帮助
    • YesApi SDK源代码下载(2019新版,最全最新) 推荐
    • 客户端SDK和示例(2018旧版)
    • 小白云端接口文档
    • 果创云开放接口短视频教程 - 2019版 赞
    • 新手视频教程 - 2017版
    • 果创云开放平台文档
    • 小白管理后台(开源版)
  • 登录
  • 注册



果创云开放接口

5703 获取计数器接口 查看接口详情

接口地址:http://api.okayapi.com/?s=App.Main_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"};
  • 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计数器名称
time字符串可选手动指定需要查询的时间,根据计数器的类型不同,每种类型的时间格式分别是:
  • 时:YmdH,例如:2020010100,即:年月日小时
  • 日:Ymd,例如:20200101,即:年月日
  • 周:YW,例如:202042,即:年周
  • 月:Ym,例如:202001,即:年月
  • 年:Y,例如:2020,即:年
  • 永久:forever,固定为forever

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

客户端请求示例

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

HTTP通用示例PHP示例
请求:
{你的接口域名}/?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 
)
*/

返回结构说明

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

果创云开放接口

9005 获取当前计数器排行榜 查看接口详情

接口地址:http://api.okayapi.com/?s=App.Main_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"};
  • 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计数器名称,支持模糊匹配,为空时取全部
num整型可选100排行榜前面多少个
start_time字符串可选开始时间,未指定时取当前相应的时间周期,示例:2020-05-14 14:29:12

客户端请求示例

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

HTTP通用示例
请求:
{你的接口域名}/?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"
}

返回结构说明

返回字段类型说明
ret整型接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码
data.err_code整型操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景
data.err_msg字符串错误提示信息,err_code非0时参考此提示信息
msg字符串提示信息,面向技术人员的帮助或错误提示信息

果创云开放接口

5701 设定计数器接口 查看接口详情

接口地址:http://api.okayapi.com/?s=App.Main_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"};
  • 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计数器名称
value整型必须0设定的起始值
min整型可选0计数器的最小值
max整型可选9999999999计数器的最大值

客户端请求示例

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

HTTP通用示例PHP示例
请求:
{你的接口域名}/?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 
)
*/

返回结构说明

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

果创云开放接口

9003 [多合一] 智能刷新接口 查看接口详情

接口地址:http://api.okayapi.com/?s=App.Main_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"};
  • 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计数器名称
value整型必须1待增量更新的值,为正数时增加,为负数则减少

客户端请求示例

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

HTTP通用示例PHP示例
请求:
{你的接口域名}/?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 
)
*/

返回结构说明

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

果创云开放接口

5702 增量更新计数器接口 查看接口详情

接口地址:http://api.okayapi.com/?s=App.Main_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"};
  • 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计数器名称
value整型必须1待增量更新的值,为正数时增加,为负数则减少

客户端请求示例

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

HTTP通用示例PHP示例
请求:
{你的接口域名}/?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 
 )
*/

返回结构说明

返回字段类型说明
ret整型接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码
data.err_code整型状态操作码,0成功,1计数器不存在
data.err_msg字符串错误提示信息,err_code非0时参考此提示信息
data.before_value整型更新前原来的值
data.after_value整型更新后的值
data.add_value整型服务端实际累加的值(尽可能累加的值,即在不超出最值的情况下尽最大可能累加的值)
data.value整型客户端期望累加的值
msg字符串提示信息,面向技术人员的帮助或错误提示信息

果创云 - 后端云低代码平台,让开发更简单


新手引导

开发者注册
客户端接入指南
30分钟新手教程
视频教程

产品

果创云
小白接口
接口大师
API托管平台
企多客商城
软件定制开发
果创云产品介绍(202004)

关于

用户服务协议

联系我们

合作:
huangchanzong@yesapi.cn
Q群2:897815708 Q群1:660311764(满) 工作时间:09:00-18:00 (周一至周六) 地址:广州市黄埔区香雪大道中68号707

关注小白平台公众号

友情链接: 果创云 | 广州果创 | 企多客 | PhalApi专业版 | PhalApi | ApiAdmin | 开发者工具
©2017-2020 V3.3.0 小白接口 果创云 YesApi.cn 广州果创网络科技有限公司 All Rights Reserved.