PhalApi开源接口框架 - 在线接口文档

#	请求方式	接口服务	接口名称	接口描述
1	GET/POST	App.Hello.World	示例接口	//请使用@desc 注释
2	GET/POST	App.TcpDevice_Main.Todo	注册设备消息通讯id	注册华允TCP设备tcp通信id
3	GET/POST	App.TcpDevice_Main.Stoplights	红绿灯控制	根据hex命令值先熄灭改变红绿灯颜色
4	GET/POST	App.TcpDevice_Main.Chargestop	绿行充电设备停止	停止设备
5	GET/POST	App.TcpDevice_Main.Chargerun	绿行充电设备启动	启动设备
6	GET/POST	App.TcpDevice_Main.Greenctrl	绿行充电设备控制	下发设备hex指令操作
7	GET/POST	App.TcpDevice_Main.Chargestatus	绿行充电设备状态	查询设备
8	GET/POST	App.TcpDevice_Main.Greenway	绿行充电设备通讯	注册平台，心跳，异步通知
9	GET/POST	App.TcpDevice_Main.Greenset	绿行充电设备配置	心跳数据结构，获取设备状态
10	GET/POST	App.Park_notify.HeartBeat	心跳接口	//请使用@desc 注释
11	GET/POST	App.Park_notify.Todo	插件接口	钉钉消息订阅接口
12	GET/POST	App.Park_notify.DataUpload	数据上传接口	//请使用@desc 注释
13	GET/POST	App.Weixin_Aesdecode.Decode	Tools接口	Aes解密工具
14	GET/POST	App.TuoQiang_dataapi.Deviceget	插件接口	查询电表状态。
15	GET/POST	App.TuoQiang_dataapi.Deviceinfo	插件接口	获取拓强云平台设备数据
16	GET/POST	App.TuoQiang_dataapi.Devicestate	插件接口	控制能源表拉闸/闭阀与合闸/开阀操作
17	GET/POST	App.TuoQiang_dataapi.Energytask	插件接口	批量获取按天统计表具用量数据，加入缓存（最长获取12个月）。
18	GET/POST	App.TuoQiang_dataapi.GetAddressDay	插件接口	执行查询表具每天用量统计记录。
19	GET/POST	App.TuoQiang_dataapi.Getaccount	插件接口	执行查询表具用量本地数据（非实时）。
20	GET/POST	App.TuoQiang_dataapi.Notify	插件接口	异步通知数据接口
21	GET/POST	App.TuoQiang_dataapi.Openacount	插件接口	电表开户。
22	GET/POST	App.TuoQiang_dataapi.Recharge	插件接口	电表充值接口（充值成功，需要以异步通知为准）
23	GET/POST	App.TuoQiang_dataapi.Security	插件接口	初始化电表,并转换模式。
24	GET/POST	App.TuoQiang_dataapi.Statistic	插件接口	按天统计表具用量数据执行入库操作，避免大量数据操作超时问题。
25	GET/POST	App.TuoQiang_dataapi.Task	插件接口	执行查询表具数据添加至缓存数据库中任务。
26	GET/POST	App.Examples_QrCode.Png	二维码 - 根据文本内容，生成二维码	可根据传入的文本内容，生成对应的二维码，还可以调整尺寸大小。可以直接输出png图片，也可以返回base64后的图片数据。
27	GET/POST	App.Examples_DataApi.CreateData	创建新数据	通用数据接口，创建一条新数据
28	GET/POST	App.Examples_Rule.JsonArray	参数示例 - JSON数组参数	演示如何配置JSON格式的数组参数，并原路返回。
29	GET/POST	App.Examples_Rule.ExplodeArray	参数示例 - 分割的数组参数	以英文逗号分割的数组，并且可以设置数组个数。
30	GET/POST	App.Examples_Rule.Str	参数示例 - 字符串参数	简单的字符串参数
31	GET/POST	App.Examples_Rule.TrueOrFalse	参数示例 - 开关参数	true或false的开关参数。
32	GET/POST	App.Examples_Rule.RangeNumber	参数示例 - 指定范围的整数参数	指定范围的整数参数，可以设置最小值、最大值，当设定默认值时，对客户端则不是必传参数。
33	GET/POST	App.Examples_Rule.Number	参数示例 - 整数参数	必须的整数参数
34	GET/POST	App.Examples_Rule.DateStr	参数示例 - 日期参数	字符串的日期参数，例如格式：Y-m-d H:i:s
35	GET/POST	App.Examples_Rule.DateTimestamp	参数示例 - 时间戳日期参数	时间戳日期参数，输入日期字符串参数，如传：2019-03-01 00:00:00，接口接收后会转成：1551369600。
36	GET/POST	App.Examples_Rule.SexEnum	参数示例 - 枚举参数	例如，男或女的性别参数。
37	GET/POST	App.Examples_Rule.RegexStr	参数示例 - 正则字符串参数	指定正则的字符串参数
38	GET/POST	App.Examples_Rule.VersionCallback	参数示例 - 版本回调参数	回调类型的参数，可以自定义参数的检测、转换和校验逻辑。例如版本号。
39	GET/POST	App.Examples_Rule.StatusEnum	参数示例 - 状态枚举参数	对于是数值的枚举范围，注意配置时请用字符串类型。
40	GET/POST	App.Examples_Rule.DefaultStr	参数示例 - 默认且必须的字符串参数	带默认值，并且为必须的字符串参数。默认是string类型，所以一般不用配置type为string。
41	GET/POST	App.Examples_DataApi.DeleteDataIDs	批量删除	通用数据接口，根据ID批量删除数据
42	GET/POST	App.Examples_CURD.Delete	数据库示例 - 删除数据	根据ID删除数据库中的一条纪录数据
43	GET/POST	App.Examples_CURD.Insert	数据库示例 - 插入数据	向数据库插入一条纪录数据
44	POST	App.Examples_CURD.Update	数据库示例 - 更新数据	根据ID更新数据库中的一条纪录数据
45	GET/POST	App.Examples_CURD.SqlDebug	数据库示例 - 演示如何进行SQL调试和相关的使用	除此接口外，其他示例也可进行在线调试。本示例将便详细说明如何调试。
46	GET/POST	App.Examples_CURD.GetList	数据库示例 - 获取分页列表数据	根据状态筛选列表数据，支持分页
47	GET	App.Examples_CURD.Get	数据库示例 - 获取数据	根据ID获取数据库中的一条纪录数据
48	POST	App.Examples_Upload.Go	文件上传 - 图片文件上传	只能上传单个图片文件
49	GET	App.Examples_Docs.Usage	文档示例 - 接口文档使用示例	接口说明，更多使用请参考官方文档http://docs.phalapi.net/#/v2.0/api-docs
50	GET/POST	App.Examples_Log.Run	日记 - 写入日志	演示日志操作，包括写系统异常类日志、业务纪录类日志、开发调试类日志
51	GET/POST	App.Examples_DataApi.UpdateData	更新数据	通用数据接口，根据ID更新单条数据
52	GET/POST	App.Examples_DataApi.DeleteData	根据ID删除数据	根据单个ID删除数据，也可以调整成根据自定义的条件删除数据
53	GET/POST	App.Examples_Response.TopResult	演示在返回结果根节点添加额外的字段返回	自定义动态返回JSON根节点，增加最外层返回消息，例如最外层的【status 状态码】和【time 当前系统时间】
54	GET/POST	App.Examples_DataApi.GetData	获取一条数据	通用数据接口，根据ID获取一条数据
55	GET/POST	App.Examples_DataApi.TableList	获取表格列表数据	通用数据接口，获取表格列表数据，默认按ID降序返回，支持分页和搜索
56	GET/POST	App.Jingqi_notify.UploadMeterReadData	插件接口	旌旗水表开放平台订阅接口
57	GET/POST	App.Weixin_YeepayLink.Divide	分账业务	计算分账业务金额进入分账列队。
58	GET/POST	App.Weixin_YeepayLink.Divideend	分账业务完成解冻	直接解冻需分账账单。
59	GET/POST	App.Weixin_YeepayLink.Notify	线上支付异步通知解析	对线上异步数据进行解析处理。
60	GET/POST	App.Weixin_YeepayLink.Profitrefund	聚合已经分账订单退款	先从已分账的账户返款后执行退款操作，返回结果
61	GET/POST	App.Weixin_YeepayLink.Wxconfig	聚合授权微信小程序	实现微信小程序支付功能
62	GET/POST	App.Weixin_YeepayLink.Transfer	聚合支付企业付款至商户号	企业付款至商户支付账户
63	GET/POST	App.Weixin_YeepayLink.Withdraw	聚合支付开通结算提现功能（易宝支付接口有问题）	实现微信小程序支付功能
64	GET/POST	App.Weixin_YeepayLink.Buildpay	聚合统一下单	实现聚合统一下单结果返回
65	GET/POST	App.Weixin_YeepayLink.Refund	聚合退款	实现聚合退款结果返回
66	GET/POST	App.Autobox_deviceinfo.Cmd	智能柜下发传感器命令	智能柜电量传感器指令下发
67	GET/POST	App.Autobox_deviceinfo.Boxnotice	智能柜借还状态通知	智能柜借还状态异步通知
68	GET/POST	App.Autobox_deviceinfo.Notice	智能柜充电状态通知	智能柜充电状态异步通知
69	GET/POST	App.Autobox_deviceinfo.Reg	注册设备消息通讯id	注册智能柜采集器tcp通信id
70	GET/POST	App.Autobox_notify.Todo	插件接口	钉钉消息订阅接口
71	GET/POST	App.Weixin_CreateSign.Sha256_HMAC	Tools接口	sha256_HMAC加密工具
72	GET/POST	App.Haikang_Main.DeviceControl	升降柱控制接口	三处升降柱同步升起和降落，非管理员擅自请勿操作
73	GET/POST	App.Haikang_Main.Todo	查询车辆详细信息	根据车牌号查询车辆详细信息
74	GET/POST	App.Dingding_notify.Todo	插件接口	钉钉消息订阅接口

切换到折叠版

温馨提示： 此接口文档根据接口代码和注释实时自动生成，可在接口类的文件注释的第一行修改左侧菜单标题。