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

#	请求方式	接口服务	接口名称	接口描述
1	GET/POST	App.App_Auth.AppleLogin	Apple 登录	App端使用Apple ID登录，首次登录自动注册新用户（支持单点登录）
2	GET/POST	App.App_RedeemCode.Redeem	兑换VIP	使用兑换码兑换VIP会员（需要登录）
3	GET/POST	App.App_CustomerService.GetList	获取客服QQ号列表	App端获取所有启用的客服QQ号
4	GET/POST	App.App_Payment.SyncFromApple	Apple 同步恢复购买	当数据库无会员记录时，APP 调 Apple 获取交易后，传 originalTransactionId 列表来同步恢复
5	GET/POST	App.App_Payment.Restore	恢复购买	恢复购买（支持未登录设备ID，已登录Token），返回数据经 JWT 加密
6	GET/POST	App.App_Payment.Verify	校验支付	StoreKit2 支付完成后，验证交易并授予会员权益。返回数据经 JWT 加密
7	GET/POST	App.App_Payment.BindDevice	绑定设备会员到账号	将设备购买的会员绑定到登录账号（需要登录）
8	GET/POST	App.App_Payment.GetMembershipStatus	获取会员状态	检查当前用户/设备的会员状态，返回数据经 JWT 加密
9	GET/POST	App.App_AppVersion.GetLatest	获取最新版本信息	App端获取最新版本号、新特性、是否强制更新
10	GET/POST	App.App_Agreement.GetContent	获取协议内容	App端获取用户协议或隐私政策内容
11	GET/POST	App.App_Order.Create	创建订单	创建预支付订单（支持未登录+设备ID），StoreKit2 使用
12	GET/POST	App.App_SubscriptionPlan.GetList	获取订阅套餐列表	App端获取所有上架的VIP订阅套餐，支持国际化
13	GET/POST	App.App_Banner.GetList	获取轮播图列表	App端获取启用的轮播图列表
14	GET/POST	App.App_AppleCallback.Notify	Apple 服务器通知回调	接收 Apple App Store Server Notifications V2 回调
15	GET/POST	App.Hello.World	示例接口	//请使用@desc 注释
16	GET/POST	App.Examples_QrCode.Png	二维码 - 根据文本内容，生成二维码	可根据传入的文本内容，生成对应的二维码，还可以调整尺寸大小。可以直接输出png图片，也可以返回base64后的图片数据。
17	GET/POST	App.Examples_DataApi.CreateData	创建新数据	通用数据接口，创建一条新数据
18	GET/POST	App.Examples_Rule.JsonArray	参数示例 - JSON数组参数	演示如何配置JSON格式的数组参数，并原路返回。
19	GET/POST	App.Examples_Rule.ExplodeArray	参数示例 - 分割的数组参数	以英文逗号分割的数组，并且可以设置数组个数。
20	GET/POST	App.Examples_Rule.Str	参数示例 - 字符串参数	简单的字符串参数
21	GET/POST	App.Examples_Rule.TrueOrFalse	参数示例 - 开关参数	true或false的开关参数。
22	GET/POST	App.Examples_Rule.RangeNumber	参数示例 - 指定范围的整数参数	指定范围的整数参数，可以设置最小值、最大值，当设定默认值时，对客户端则不是必传参数。
23	GET/POST	App.Examples_Rule.Number	参数示例 - 整数参数	必须的整数参数
24	GET/POST	App.Examples_Rule.DateStr	参数示例 - 日期参数	字符串的日期参数，例如格式：Y-m-d H:i:s
25	GET/POST	App.Examples_Rule.DateTimestamp	参数示例 - 时间戳日期参数	时间戳日期参数，输入日期字符串参数，如传：2019-03-01 00:00:00，接口接收后会转成：1551369600。
26	GET/POST	App.Examples_Rule.SexEnum	参数示例 - 枚举参数	例如，男或女的性别参数。
27	GET/POST	App.Examples_Rule.RegexStr	参数示例 - 正则字符串参数	指定正则的字符串参数
28	GET/POST	App.Examples_Rule.VersionCallback	参数示例 - 版本回调参数	回调类型的参数，可以自定义参数的检测、转换和校验逻辑。例如版本号。
29	GET/POST	App.Examples_Rule.StatusEnum	参数示例 - 状态枚举参数	对于是数值的枚举范围，注意配置时请用字符串类型。
30	GET/POST	App.Examples_Rule.DefaultStr	参数示例 - 默认且必须的字符串参数	带默认值，并且为必须的字符串参数。默认是string类型，所以一般不用配置type为string。
31	GET/POST	App.Examples_Response.Debug	展示调试相关能力	使用前请开启调试模式，效果更佳
32	GET/POST	App.Examples_DataApi.DeleteDataIDs	批量删除	通用数据接口，根据ID批量删除数据
33	GET/POST	App.Examples_CURD.Delete	数据库示例 - 删除数据	根据ID删除数据库中的一条纪录数据
34	GET/POST	App.Examples_CURD.Insert	数据库示例 - 插入数据	向数据库插入一条纪录数据
35	POST	App.Examples_CURD.Update	数据库示例 - 更新数据	根据ID更新数据库中的一条纪录数据
36	GET/POST	App.Examples_CURD.SqlDebug	数据库示例 - 演示如何进行SQL调试和相关的使用	除此接口外，其他示例也可进行在线调试。本示例将便详细说明如何调试。
37	GET/POST	App.Examples_CURD.GetList	数据库示例 - 获取分页列表数据	根据状态筛选列表数据，支持分页
38	GET	App.Examples_CURD.Get	数据库示例 - 获取数据	根据ID获取数据库中的一条纪录数据
39	POST	App.Examples_Upload.Go	文件上传 - 图片文件上传	只能上传单个图片文件
40	GET	App.Examples_Docs.Usage	文档示例 - 接口文档使用示例	接口说明，更多使用请参考官方文档http://docs.phalapi.net/#/v2.0/api-docs
41	GET/POST	App.Examples_Log.Run	日记 - 写入日志	演示日志操作，包括写系统异常类日志、业务纪录类日志、开发调试类日志
42	GET/POST	App.Examples_DataApi.UpdateData	更新数据	通用数据接口，根据ID更新单条数据
43	GET/POST	App.Examples_DataApi.DeleteData	根据ID删除数据	根据单个ID删除数据，也可以调整成根据自定义的条件删除数据
44	GET/POST	App.Examples_Response.TopResult	演示在返回结果根节点添加额外的字段返回	自定义动态返回JSON根节点，增加最外层返回消息，例如最外层的【status 状态码】和【time 当前系统时间】
45	GET/POST	App.Examples_DataApi.GetData	获取一条数据	通用数据接口，根据ID获取一条数据
46	GET/POST	App.Examples_DataApi.TableList	获取表格列表数据	通用数据接口，获取表格列表数据，默认按ID降序返回，支持分页和搜索
47	GET/POST	App.Admin_AppVersion.Get	获取版本信息	管理后台获取当前版本信息
48	GET/POST	App.Admin_AppVersion.Save	设置版本信息	管理后台设置/更新App版本号、新特性、是否强制更新
49	GET/POST	App.Admin_AppUser.GetList	用户列表	管理后台获取所有注册用户列表（分页，支持关键词搜索）
50	GET/POST	App.Admin_AppUser.GetInfo	用户详情	管理后台根据ID获取单个用户信息
51	GET/POST	App.Admin_AppUser.ToggleStatus	禁用/启用用户	管理后台切换用户状态，被禁用的用户无法通过Apple登录
52	GET/POST	App.Admin_RedeemCode.GetList	兑换码列表	管理后台获取兑换码列表（分页）
53	GET/POST	App.Admin_RedeemCode.Delete	删除兑换码	管理后台删除兑换码
54	GET/POST	App.Admin_RedeemCode.Enable	启用兑换码	管理后台启用已禁用的兑换码
55	GET/POST	App.Admin_RedeemCode.Generate	批量生成兑换码	管理后台批量生成VIP兑换码，生成后返回txt文件下载链接
56	GET/POST	App.Admin_RedeemCode.Disable	禁用兑换码	管理后台禁用兑换码
57	GET/POST	App.Admin_SubscriptionPlan.Edit	修改套餐	管理后台修改VIP订阅套餐
58	GET/POST	App.Admin_SubscriptionPlan.Delete	删除套餐	管理后台删除VIP订阅套餐
59	GET/POST	App.Admin_SubscriptionPlan.GetList	套餐列表	管理后台获取VIP订阅套餐列表（分页）
60	GET/POST	App.Admin_SubscriptionPlan.Add	添加套餐	管理后台添加VIP订阅套餐
61	GET/POST	App.Admin_Membership.GetList	会员列表	管理后台获取所有会员列表（分页，支持筛选），包含下单时间、到期时间、会员来源、套餐类型等关键信息
62	GET/POST	App.Admin_CustomerService.Edit	修改客服QQ	管理后台修改客服QQ号
63	GET/POST	App.Admin_CustomerService.Delete	删除客服QQ	管理后台删除客服QQ号
64	GET/POST	App.Admin_CustomerService.GetList	客服QQ列表	管理后台获取客服QQ号列表（分页）
65	GET/POST	App.Admin_CustomerService.Add	添加客服QQ	管理后台添加客服QQ号
66	GET/POST	App.Admin_Agreement.GetList	协议列表	管理后台获取协议列表（分页）
67	GET/POST	App.Admin_Agreement.Save	新增/修改协议	管理后台新增或修改用户协议/隐私政策（同类型只保留一条）
68	GET/POST	App.Admin_Agreement.Get	获取协议详情	管理后台获取用户协议/隐私政策详情
69	GET/POST	App.Admin_Login.Login	管理后台登录	管理员使用用户名密码登录，返回JWT Token
70	GET/POST	App.Admin_Login.GetInfo	获取管理员信息	获取当前登录管理员的基本信息
71	GET/POST	App.Admin_Order.GetList	订单列表	管理后台获取订单列表（分页）
72	GET/POST	App.Admin_Banner.Edit	修改轮播图	管理后台修改轮播图（可选上传新图片）
73	GET/POST	App.Admin_Banner.Delete	删除轮播图	管理后台删除轮播图
74	GET/POST	App.Admin_Banner.Add	添加轮播图	管理后台添加轮播图（上传图片）
75	GET/POST	App.Admin_Banner.GetList	轮播图列表	管理后台获取轮播图列表（分页）

切换到折叠版

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