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

#	请求方式	接口服务	接口名称	接口描述
1	GET/POST	App.Site.SaveAddress	保存收货地址	中奖用户在H5填写收货地址，按核销码定位中奖记录
2	GET/POST	App.Site.Join	参与活动	填写信息参与活动；手机号按活动登记字段配置可选填；H5按手机号去重，小程序端（带wx_token）按微信号去重复用记录
3	GET/POST	App.Site.MyWins	我的中奖记录	查询参与用户在该活动的全部中奖记录（含核销码/核销状态/收货地址）
4	GET/POST	App.Site.Draw	抽奖	服务端完成资格/次数/概率/库存校验并返回抽奖结果；带wx_token（小程序）时每日/累计限次按微信号(openid)计数
5	GET/POST	App.Site.Activity	活动配置	返回活动配置与奖品列表，供H5渲染参与页

切换到展开版

#	请求方式	接口服务	接口名称	接口描述
1	GET/POST	App.Hello.World	示例接口	//请使用@desc 注释

切换到展开版

#	请求方式	接口服务	接口名称	接口描述
1	GET/POST	App.User.Register	主办方注册	已关闭自助注册，请使用激活码登录
2	GET/POST	App.User.Login	主办方登录	登录成功返回token，管理端接口均需携带
3	GET/POST	App.User.Info	当前登录商户信息	返回账号、激活码、授权到期时间（早期无码账号expire_time为null）
4	GET/POST	App.User.CodeLogin	激活码登录	校验激活码有效性/时效/绑定域名，首次登录自动创建主办方账号

切换到展开版

#	请求方式	接口服务	接口名称	接口描述
1	GET/POST	App.Whitelist.Delete	删除名单手机号	//请使用@desc 注释
2	GET/POST	App.Whitelist.List	名单分页列表	//请使用@desc 注释
3	GET/POST	App.Whitelist.Add	批量添加手机号	格式错误或已存在的自动跳过

切换到展开版

#	请求方式	接口服务	接口名称	接口描述
1	GET/POST	App.Prize.Save	保存奖品（新增/编辑）	id为0或不传时新增，否则编辑
2	GET/POST	App.Prize.Delete	删除奖品	按奖品ID删除
3	GET/POST	App.Prize.List	奖品列表	查询活动下的全部奖品

切换到展开版

#	请求方式	接口服务	接口名称	接口描述
1	GET/POST	App.Weapp.Login	小程序登录	用 wx.login 的 code 调微信 jscode2session 换取 openid，并签发防伪 wx_token。

切换到展开版

#	请求方式	接口服务	接口名称	接口描述
1	GET/POST	App.PhonePrize.SetPrize	修改内定奖品	已使用的内定记录不能修改
2	GET/POST	App.PhonePrize.List	内定记录分页列表	//请使用@desc 注释
3	GET/POST	App.PhonePrize.Delete	删除内定记录	//请使用@desc 注释
4	GET/POST	App.PhonePrize.Add	添加内定	设置后该手机号在本活动抽奖时必中该奖品（一次有效）

切换到展开版

#	请求方式	接口服务	接口名称	接口描述
1	GET/POST	App.Code.All	全部抽奖码（导出用）	//请使用@desc 注释
2	GET/POST	App.Code.Delete	删除抽奖码	//请使用@desc 注释
3	GET/POST	App.Code.Generate	批量生成抽奖码	按活动批量生成，可整批绑定指定奖品（绑定后使用该码必中该奖品；绑定时按数量预占库存）
4	GET/POST	App.Code.List	抽奖码分页列表	//请使用@desc 注释
5	GET/POST	App.Code.SetPrize	设置码的内定奖品	设置后使用该码必中该奖品；prize_id为0取消绑定（仅参与凭证）

切换到展开版

#	请求方式	接口服务	接口名称	接口描述
1	GET/POST	App.Examples_QrCode.Png	二维码 - 根据文本内容，生成二维码	可根据传入的文本内容，生成对应的二维码，还可以调整尺寸大小。可以直接输出png图片，也可以返回base64后的图片数据。
2	GET/POST	App.Examples_DataApi.CreateData	创建新数据	通用数据接口，创建一条新数据
3	GET/POST	App.Examples_Rule.JsonArray	参数示例 - JSON数组参数	演示如何配置JSON格式的数组参数，并原路返回。
4	GET/POST	App.Examples_Rule.ExplodeArray	参数示例 - 分割的数组参数	以英文逗号分割的数组，并且可以设置数组个数。
5	GET/POST	App.Examples_Rule.Str	参数示例 - 字符串参数	简单的字符串参数
6	GET/POST	App.Examples_Rule.TrueOrFalse	参数示例 - 开关参数	true或false的开关参数。
7	GET/POST	App.Examples_Rule.RangeNumber	参数示例 - 指定范围的整数参数	指定范围的整数参数，可以设置最小值、最大值，当设定默认值时，对客户端则不是必传参数。
8	GET/POST	App.Examples_Rule.Number	参数示例 - 整数参数	必须的整数参数
9	GET/POST	App.Examples_Rule.DateStr	参数示例 - 日期参数	字符串的日期参数，例如格式：Y-m-d H:i:s
10	GET/POST	App.Examples_Rule.DateTimestamp	参数示例 - 时间戳日期参数	时间戳日期参数，输入日期字符串参数，如传：2019-03-01 00:00:00，接口接收后会转成：1551369600。
11	GET/POST	App.Examples_Rule.SexEnum	参数示例 - 枚举参数	例如，男或女的性别参数。
12	GET/POST	App.Examples_Rule.RegexStr	参数示例 - 正则字符串参数	指定正则的字符串参数
13	GET/POST	App.Examples_Rule.VersionCallback	参数示例 - 版本回调参数	回调类型的参数，可以自定义参数的检测、转换和校验逻辑。例如版本号。
14	GET/POST	App.Examples_Rule.StatusEnum	参数示例 - 状态枚举参数	对于是数值的枚举范围，注意配置时请用字符串类型。
15	GET/POST	App.Examples_Rule.DefaultStr	参数示例 - 默认且必须的字符串参数	带默认值，并且为必须的字符串参数。默认是string类型，所以一般不用配置type为string。
16	GET/POST	App.Examples_Response.Debug	展示调试相关能力	使用前请开启调试模式，效果更佳
17	GET/POST	App.Examples_DataApi.DeleteDataIDs	批量删除	通用数据接口，根据ID批量删除数据
18	GET/POST	App.Examples_CURD.Delete	数据库示例 - 删除数据	根据ID删除数据库中的一条纪录数据
19	GET/POST	App.Examples_CURD.Insert	数据库示例 - 插入数据	向数据库插入一条纪录数据
20	POST	App.Examples_CURD.Update	数据库示例 - 更新数据	根据ID更新数据库中的一条纪录数据
21	GET/POST	App.Examples_CURD.SqlDebug	数据库示例 - 演示如何进行SQL调试和相关的使用	除此接口外，其他示例也可进行在线调试。本示例将便详细说明如何调试。
22	GET/POST	App.Examples_CURD.GetList	数据库示例 - 获取分页列表数据	根据状态筛选列表数据，支持分页
23	GET	App.Examples_CURD.Get	数据库示例 - 获取数据	根据ID获取数据库中的一条纪录数据
24	POST	App.Examples_Upload.Go	文件上传 - 图片文件上传	只能上传单个图片文件
25	GET	App.Examples_Docs.Usage	文档示例 - 接口文档使用示例	接口说明，更多使用请参考官方文档http://docs.phalapi.net/#/v2.0/api-docs
26	GET/POST	App.Examples_Log.Run	日记 - 写入日志	演示日志操作，包括写系统异常类日志、业务纪录类日志、开发调试类日志
27	GET/POST	App.Examples_DataApi.UpdateData	更新数据	通用数据接口，根据ID更新单条数据
28	GET/POST	App.Examples_DataApi.DeleteData	根据ID删除数据	根据单个ID删除数据，也可以调整成根据自定义的条件删除数据
29	GET/POST	App.Examples_Response.TopResult	演示在返回结果根节点添加额外的字段返回	自定义动态返回JSON根节点，增加最外层返回消息，例如最外层的【status 状态码】和【time 当前系统时间】
30	GET/POST	App.Examples_DataApi.GetData	获取一条数据	通用数据接口，根据ID获取一条数据
31	GET/POST	App.Examples_DataApi.TableList	获取表格列表数据	通用数据接口，获取表格列表数据，默认按ID降序返回，支持分页和搜索

切换到展开版

#	请求方式	接口服务	接口名称	接口描述
1	GET/POST	App.Record.WinList	中奖记录列表	分页查询活动中奖记录（含参与人手机号/姓名、奖品与核销码）
2	GET/POST	App.Record.WinDelete	删除单条中奖记录	//请使用@desc 注释
3	GET/POST	App.Record.DrawDelete	删除单条抽奖记录	//请使用@desc 注释
4	GET/POST	App.Record.WinUnverify	反核销中奖记录	将已核销记录恢复为待核销
5	GET/POST	App.Record.WinLogistics	录入物流单号	为中奖记录录入/修改/清除物流单号
6	GET/POST	App.Record.DrawList	抽奖记录列表	分页查询活动抽奖记录（含参与人手机号/姓名与中奖奖品）
7	GET/POST	App.Record.WinVerify	核销中奖记录	后台人工核销，将中奖记录标记为已核销
8	GET/POST	App.Record.WinClear	清空活动全部中奖记录	//请使用@desc 注释
9	GET/POST	App.Record.DrawClear	清空活动全部抽奖记录	//请使用@desc 注释

切换到展开版

#	请求方式	接口服务	接口名称	接口描述
1	GET/POST	App.Activity.Save	保存活动（新增/编辑）	id为0或不传时新增，否则编辑
2	GET/POST	App.Activity.Delete	删除活动	删除指定活动，同时清空其奖品、参与用户、抽奖/中奖记录、抽奖码、名单等关联数据
3	GET/POST	App.Activity.ChangeStatus	开启/暂停活动	切换活动状态
4	GET/POST	App.Activity.List	活动列表	查询当前主办方的全部活动
5	GET/POST	App.Activity.Detail	活动详情	查询单个活动详情（含装修/文案/模块/分享配置）

切换到展开版

#	请求方式	接口服务	接口名称	接口描述

切换到展开版

#	请求方式	接口服务	接口名称	接口描述
1	POST	App.Material.Upload	上传素材	上传图片/音频，返回可访问URL，用于装修配置的背景图/音频等
2	GET/POST	App.Material.Delete	删除素材	//请使用@desc 注释
3	GET/POST	App.Material.List	素材列表	分库查询：user为自己的素材库，builtin为平台内置库（只读）

切换到展开版

#	请求方式	接口服务	接口名称	接口描述
1	POST	App.Admin.MaterialUpload	上传内置库素材	内置库素材对所有商户可见
2	GET/POST	App.Admin.SaveStorageConfig	保存存储配置	七牛云模式仅作用于商户上传的素材，内置库素材始终保存本地
3	GET/POST	App.Admin.ChangePassword	修改超管密码	验证原密码后修改；token永久有效，改密后无需重新登录
4	GET/POST	App.Admin.ToggleCode	停用/启用激活码	停用后该码租户的管理端与H5活动页一并停用
5	GET/POST	App.Admin.MaterialList	内置库素材列表	//请使用@desc 注释
6	GET/POST	App.Admin.MaterialDelete	删除内置库素材	//请使用@desc 注释
7	GET/POST	App.Admin.DeleteCode	删除激活码	//请使用@desc 注释
8	GET/POST	App.Admin.MaterialManageDelete	删除用户库素材（文件+记录）	//请使用@desc 注释
9	GET/POST	App.Admin.AddCode	单个添加激活码（手动指定码）	码需手动输入，4-32位字母/数字/短横线，全局唯一
10	GET/POST	App.Admin.BatchDeleteCode	批量删除激活码	ids为逗号分隔的ID串
11	GET/POST	App.Admin.MaterialManageBatchDelete	批量删除用户库素材（文件+记录）	ids为逗号分隔的ID串
12	GET/POST	App.Admin.ClearExpired	清理已过期激活码	删除已过期且未绑定租户的激活码
13	GET/POST	App.Admin.ClearExpiredMaterials	清空过期素材	删除激活码过期超过7天的租户上传的全部素材（文件+记录）
14	GET/POST	App.Admin.CodeList	激活码列表	//请使用@desc 注释
15	GET/POST	App.Admin.RenewCode	激活码续期	从当前到期时间（已过期的从当前时间）起顺延指定天数
16	GET/POST	App.Admin.GenerateCode	生成激活码	默认有效期1个月；停用后该码租户管理端与H5一并停用
17	GET/POST	App.Admin.MaterialManageList	素材管理列表（全平台用户库素材）	可按媒体类型/文件名/上传者（账号或激活码）筛选，时间正倒序
18	GET/POST	App.Admin.GetStorageConfig	获取存储配置	secretKey 脱敏返回（已配置时为 ********）
19	GET/POST	App.Admin.SetDomain	设置激活码的前端活动域名	商户端复制活动链接时优先使用该域名；传空字符串清除
20	GET/POST	App.Admin.Login	超管登录	账号在 api/config/app.php 的 super_admin 配置；密码优先取数据库覆盖值（修改密码后），否则用配置

切换到展开版

接口服务列表 (94)

我的应用 (94)