兑换商城v2.1.0

[TOC] <h2>修订记录</h2> <table> <thead> <tr> <th style="text-align: left;">版本</th> <th style="text-align: left;">日期</th> <th style="text-align: left;">操作内容</th> <th style="text-align: left;">说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">v2.1.0</td> <td style="text-align: left;">20190301</td> <td style="text-align: left;">1、补充目录； 2、新增12-14接口； 3、更新【8、我的兑换记录】接口；</td> <td style="text-align: left;"></td> </tr> </tbody> </table> <h2>接口地址</h2> 接口地址 正式：<a href="http://exchangemall.uc108.com/mobile">http://exchangemall.uc108.com/mobile</a> 内网稳定：<a href="http://exchangemall.uc108.org:1505/mobile">http://exchangemall.uc108.org:1505/mobile</a> <h2>Code码</h2> <ul> <li>Code说明字典</li> </ul> <table> <thead> <tr> <th style="text-align: left;">值</th> <th style="text-align: left;">说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">0</td> <td style="text-align: left;">正常</td> </tr> <tr> <td style="text-align: left;">10000</td> <td style="text-align: left;">服务器处理异常</td> </tr> <tr> <td style="text-align: left;">10001</td> <td style="text-align: left;">服务暂停</td> </tr> <tr> <td style="text-align: left;">10002</td> <td style="text-align: left;">IP被限制</td> </tr> <tr> <td style="text-align: left;">10003</td> <td style="text-align: left;">没有足够的权限</td> </tr> <tr> <td style="text-align: left;">10004</td> <td style="text-align: left;">请求参数不合法</td> </tr> <tr> <td style="text-align: left;">10005</td> <td style="text-align: left;">不合法的应用ID</td> </tr> <tr> <td style="text-align: left;">10006</td> <td style="text-align: left;">不合法的用户ID</td> </tr> <tr> <td style="text-align: left;">10007</td> <td style="text-align: left;">不合法的授权令牌</td> </tr> <tr> <td style="text-align: left;">10008</td> <td style="text-align: left;">无效的授权令牌</td> </tr> <tr> <td style="text-align: left;">10009</td> <td style="text-align: left;">授权令牌已过期</td> </tr> <tr> <td style="text-align: left;">10010</td> <td style="text-align: left;">未登录</td> </tr> <tr> <td style="text-align: left;">30000</td> <td style="text-align: left;">活动不存在</td> </tr> <tr> <td style="text-align: left;">30002</td> <td style="text-align: left;">活动已过期</td> </tr> <tr> <td style="text-align: left;">30003</td> <td style="text-align: left;">活动奖品不存在</td> </tr> <tr> <td style="text-align: left;">30006</td> <td style="text-align: left;">奖品发放失败</td> </tr> <tr> <td style="text-align: left;">50001</td> <td style="text-align: left;">签名验证失败</td> </tr> <tr> <td style="text-align: left;">50002</td> <td style="text-align: left;">操作标识唯一性验证失败</td> </tr> <tr> <td style="text-align: left;">50003</td> <td style="text-align: left;">奖励物品单位与数量验证</td> </tr> <tr> <td style="text-align: left;">50004</td> <td style="text-align: left;">应用验证失败</td> </tr> <tr> <td style="text-align: left;">50005</td> <td style="text-align: left;">奖励物品合法性验证</td> </tr> <tr> <td style="text-align: left;">50006</td> <td style="text-align: left;">活动验证失败</td> </tr> <tr> <td style="text-align: left;">50007</td> <td style="text-align: left;">扩展参数验证不通过</td> </tr> <tr> <td style="text-align: left;">50008</td> <td style="text-align: left;">兑换券不足</td> </tr> <tr> <td style="text-align: left;">50009</td> <td style="text-align: left;">凭据不可用</td> </tr> <tr> <td style="text-align: left;">50010</td> <td style="text-align: left;">兑换失败</td> </tr> </tbody> </table> <ul> <li>备注：无</li> </ul> <h2>接口</h2> <h3>1、获取活动最新兑换记录</h3> 简要描述： <ul> <li>获取活动最新兑换记录</li> </ul> 请求URL： <ul> <li><code>Activity/GetNewExchangeRecord</code></li> </ul> 请求方式： <ul> <li>get </li> </ul> 参数： <pre><code>{ activityGuid:"活动guid "}</code></pre> 返回示例 <pre><code> { "Status": true, "Code": 0, "Message": "", "Data": [ { "UserName": "ct12313", "PrizeName": "30元话费" }, { "UserName": "ct12313", "PrizeName": "30元话费" } ] }</code></pre> <h3>2、获取活动奖品列表</h3> 简要描述： <ul> <li>获取活动奖品列表</li> </ul> 请求URL： <ul> <li><code>Activity/GetActivityItemList</code></li> </ul> 请求方式： <ul> <li>get </li> </ul> 参数： <pre><code>{ activityGuid:"活动guid "}</code></pre> 返回示例 <pre><code> { "Status": true, "Code": 0, "Message": "", "Data": [ { "PrizeID":111, "Price":123 "PrizeName": 1, "Descript":"兑换物品描述", "ImageUrl": "xxxx", "ItemPrefixType":"JD", "CurrentTermLeft":123 } ] }</code></pre> <h3>3、活动奖品详情【未使用】</h3> 简要描述： <ul> <li>活动奖品详情</li> </ul> 请求URL： <ul> <li><code>ActivityItem/GetDetailInfo</code></li> </ul> 请求方式： <ul> <li>get </li> </ul> 参数： <pre><code> { activityGuid:"活动guid ",”PrizeID”:111}</code></pre> 返回示例 <pre><code> { "Status": true, "Code": 0, "Message": "", "Data": { "PriceID":123, "PrizeName": "美的压力锅", "Price": 345, "Descript": "美的压力锅美的压力锅美的压力锅美的压力锅美的压力锅美的压力锅美的压力锅", "ImageUrl": "xxxxxxxxx", "ItemPrefixType": "DJ" } }</code></pre> <h3>4、兑换道具/服装等</h3> 简要描述： <ul> <li>兑换道具/服装等</li> </ul> 请求URL： <ul> <li><code>Activity/ ExchangeProp</code></li> </ul> 请求头 请求头添加 "ClientLinkID":123123 说明：1、kpi接入的传 2、ClientLinkID的值为Client/ReportData接口上报参数ClientLinkID的值 请求方式： <ul> <li>post </li> </ul> 参数： <pre><code> { ActivityGuid:"活动guid", PrizeID:2,” Number”:1,” UserID”:1 }</code></pre> 返回示例 <pre><code> { "Status": true, "Code": 0, "Message": "", "Data": null }</code></pre> 备注：Status为true标识兑换成功 <h3>5、兑换实物</h3> 简要描述： <ul> <li>兑换实物</li> </ul> 请求URL： <ul> <li><code>Activity/ExchangeRealItem</code></li> </ul> 请求头 请求头添加 "ClientLinkID":123123 说明：1、kpi接入的传 2、ClientLinkID的值为Client/ReportData接口上报参数ClientLinkID的值 请求方式： <ul> <li>post</li> </ul> 参数： <pre><code> { ActivityGuid:"活动guid", PrizeID:2,” Number”:1,” UserID”:1,” Mobile”:手机号,” Recipients”:”收件人”,” Address”:”收件地址” }</code></pre> 返回示例 <pre><code> { "Status": true, "Code": 0, "Message": "", "Data": null }</code></pre> 备注：Status为true标识兑换成功 <h3>6、兑换话费</h3> 简要描述： <ul> <li>兑换话费</li> </ul> 请求URL： <ul> <li><code>Activity/ExchangeMobileBill</code></li> </ul> 请求头 请求头添加 "ClientLinkID":123123 说明：1、kpi接入的传 2、ClientLinkID的值为Client/ReportData接口上报参数ClientLinkID的值 请求方式： <ul> <li>post</li> </ul> 参数： <pre><code>{ ActivityGuid:"活动guid", PrizeID:2,” Number”:1,” UserID”:1,” Mobile”:手机号” }</code></pre> 返回示例 <pre><code> { "Status": true, "Code": 0, "Message": "", "Data": null }</code></pre> 备注：Status为true标识兑换成功 <h3>7、兑换银子</h3> 简要描述： <ul> <li>兑换银子</li> </ul> 请求URL： <ul> <li><code>Activity/ExchangeSilver</code></li> </ul> 请求头 请求头添加 "ClientLinkID":123123 说明：1、kpi接入的传 2、ClientLinkID的值为Client/ReportData接口上报参数ClientLinkID的值 请求方式： <ul> <li>post</li> </ul> 参数： <pre><code>{ ActivityGuid:"活动guid", PrizeID:2,” Number”:1,” UserID”:1,” Mobile”:手机号” }</code></pre> 备注：SilverTo:1-保险箱、3-IOS后备箱、4-游戏 返回示例 <pre><code> { "Status": true, "Code": 0, "Message": "", "Data": null }</code></pre> 备注：Status为true标识兑换成功 <h3>8、我的兑换券记录</h3> 简要描述： <ul> <li>我的兑换券记录</li> </ul> 请求URL： <ul> <li><code>UserTickets/GetMyTicketsRecord</code></li> </ul> 请求头 请求头添加 "ClientLinkID":123123 说明：1、kpi接入的传 2、ClientLinkID的值为Client/ReportData接口上报参数ClientLinkID的值 请求方式： <ul> <li>get</li> </ul> 参数： <pre><code> { "UserID":1, "OperateType":1 --操作类型（1，奖励；2，兑换；3，过期） "PageIndex":1, "pageSize":20 --可不传，默认为20 }</code></pre> 返回示例 <pre><code> { "Status": true, "Code": 0, "Message": "", "Data": { "LogList":[{ "LogCreateTime": "2016/05/30 18:14:00", "OperateNumber": 123, "OperateType": 1,//操作类型（1，奖励；2，兑换；3，过期） "Descript":"记录描述", "ExpiredTime":20160101,//过期时间 "ActivityId":123,//兑换活动Id "OrderNo":"asdfas112"//订单号(来源序列号) }], "RecordCount":122, "PageSize":20 } }</code></pre> <h3>9、查询指定日期用户会过期兑换券数量</h3> 简要描述： <ul> <li>查询指定日期用户会过期兑换券数量</li> </ul> 请求URL： <ul> <li><code>UserTickets/ GetExpireNum</code></li> </ul> 请求方式： <ul> <li>get</li> </ul> 参数： <pre><code>{ "UserID":1 "Date":20160707 --可不传，默认获取截止下个月1号过期的 }</code></pre> 返回示例 <pre><code>{ "Status": true, "Code": 0, "Message": "", "Data": 88888 }</code></pre> <h3>10、我的兑换券数量</h3> 简要描述： <ul> <li>我的兑换券数量</li> </ul> 请求URL： <ul> <li><code>UserTickets/ GetLeftNum</code></li> </ul> 请求方式： <ul> <li>get</li> </ul> 参数： <pre><code>{” UserID”:1 }</code></pre> 返回示例 <pre><code>{ "Status": true, "Code": 0, "Message": "", "Data": 88888 }</code></pre> <h3>11、客户端上报客户端信息接口（KPI项目）【未使用】</h3> 简要描述： <ul> <li>客户端上报客户端信息接口（KPI项目）</li> </ul> 请求URL： <ul> <li><code>Client/ReportData</code></li> </ul> 请求方式： <ul> <li>post</li> </ul> 参数： <pre><code>{ "ClientLinkID":"",//客户端生成的唯一标识 "GsClientData":"{\"a\":\"a\"}"//客户端信息 }</code></pre> 返回示例 <pre><code>{ "Code": 0, "Message": "", "Data": null }</code></pre> <h3>12、用户手机号获取</h3> 简要描述： <ul> <li>用户手机号获取</li> </ul> 请求URL： <ul> <li><code>Activity/GetUserMobile</code></li> </ul> 请求方式： <ul> <li>Get</li> </ul> 参数： <pre><code> {"UserID":1 }</code></pre> 返回示例 <pre><code> { "Status": true, "Code": 0, "Message": "", "Data": "18745784511" }</code></pre> 备注：Status为true标识发送成功 <h3>13、卡密信息短信发送</h3> 简要描述： <ul> <li>卡密信息短信发送</li> </ul> 请求URL： <ul> <li><code>Activity/SendSmsMessage</code></li> </ul> 请求方式： <ul> <li>post</li> </ul> 参数： <pre><code> {"ItemTypeId":30001,"ItemId":30001,"ItemCode":"SW-CC-JDC","ItemName":"京东卡","CardNum:"JDV31860000806000143","CardPwd":"4AA0-D731-3DEE-5310","UserID":1,"Mobile": "18723860669" }</code></pre> 返回示例 <pre><code> { "Status": true, "Code": 0, "Message": "", "Data": null }</code></pre> 备注：Status为true标识发送成功 <h3>14、发放详情明细</h3> 简要描述： <ul> <li>发放详情明细：分为实物、卡密、话费、道具、财富三种类型</li> </ul> 请求URL： <ul> <li><code>UserTickets/GetUserExchangeDetail</code></li> </ul> 请求方式： <ul> <li>Get</li> </ul> 参数： <pre><code> {ActivityId:123,"UserID":1,"OrderNo":"sdfsa123","TimeStamp":11222121}</code></pre> 返回示例 实物类的Data返回如下： <pre><code> { "Status": true, "Code": 0, "Message": "", "Data": { //道具、财富 "VirtualItemInfo":{"Status":1},//(1-未发放 ;2-发放失败 ;3-已发放) //话费 "MobileItemInfo":{"Mobile":"123545546767", "Status":1},//(1-未发放 ;2-发放失败 ;3-已发放) //卡密 "JdCardInfo":{ "Status":1,//(1-未发放 ;2-发放失败 ;3-已发放) "ItemId":300002,//物品ID "ItemCode":"SW-CC-JDC",//物品代号 "ItemName":"京东卡",//物品名称 "ItemTypeId":300002,//类别ID "CardNum":"sdfsfsdfsdf",//卡号 "CardPwd":"xvcxcvxcv"//卡密 } //实物 "RealItemInfo":{ "Status":1,//(1-未发放 ;2-发放失败 ;3-已发放) "ExpressCode":"1323599459",//运单号 "Recipients":"张三",//接收人 "Mobile":"18533945949",//手机号 "Address":"杭州市滨江区"//地址 } } }</code></pre> 返回结果说明： <table> <thead> <tr> <th>参数名</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>Status</td> <td>Int</td> <td>1-未发放 2-发放失败 3-已发放</td> </tr> </tbody> </table> 备注：Status为true标识成功 <h3>15、兑换卡密类（实物）</h3> 简要描述： <ul> <li>兑换实物</li> </ul> 请求URL： <ul> <li><code>Activity/ExchangeCardPwd</code></li> </ul> 请求头 请求头添加 "ClientLinkID":123123 说明：1、kpi接入的传 2、ClientLinkID的值为Client/ReportData接口上报参数ClientLinkID的值 请求方式： <ul> <li>post</li> </ul> 参数： <pre><code> { ActivityGuid:"活动guid", PrizeID:2,” Number”:1,” UserID”:1”}</code></pre> 返回示例 <pre><code> { "Status": true, "Code": 0, "Message": "", "Data": { "ItemTypeId": 30000001, "ItemId": 1212, "ItemCode": "SW-CC_DJ", "ItemName":"京东卡", "CardNum":"JDV31860000806000143", "CardPwd":"4AA0-D731-3DEE-5310" } }</code></pre> 备注：Status为true标识兑换成功

移动

兑换商城v2.1.0

页面列表