邀请有礼v2.2.0
<p>[TOC]</p>
<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>
<th style="text-align: left;">说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">v2.2.0</td>
<td style="text-align: left;">2018.9.7</td>
<td style="text-align: left;">接口完善</td>
<td style="text-align: left;">前端 秦露</td>
<td style="text-align: left;">-</td>
</tr>
</tbody>
</table>
<h2>接口文档维护者（前端 秦露）</h2>
<h2>Code约定</h2>
<h3>通用</h3>
<table>
<thead>
<tr>
<th>code</th>
<th>说明</th>
<th>客户端提示信息</th>
</tr>
</thead>
<tbody>
<tr>
<td>0</td>
<td>成功</td>
<td>-</td>
</tr>
<tr>
<td>20000</td>
<td>活动未开始</td>
<td></td>
</tr>
<tr>
<td>20001</td>
<td>活动已结束</td>
<td></td>
</tr>
<tr>
<td>20002</td>
<td>活动禁用</td>
<td></td>
</tr>
<tr>
<td>20003</td>
<td>活动不存在</td>
<td></td>
<td></td>
</tr>
</tbody>
</table>
<h3>接口4：领奖接口</h3>
<table>
<thead>
<tr>
<th>code</th>
<th>说明</th>
<th>客户端提示信息</th>
</tr>
</thead>
<tbody>
<tr>
<td>101</td>
<td>已领奖</td>
<td>-</td>
</tr>
<tr>
<td>102</td>
<td>领奖失败</td>
<td>-</td>
</tr>
</tbody>
</table>
<h3>通用约定</h3>
<table>
<thead>
<tr>
<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;">协议</td>
<td style="text-align: left;">支持HTTPS/HTTP</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">接口地址</td>
<td style="text-align: left;">开发版：<a href="http://invitegiftapi.ct108.org:1506/">http://invitegiftapi.ct108.org:1506/</a><br>提测版：<a href="http://invitegiftapi.ct108.org:1507">http://invitegiftapi.ct108.org:1507</a> <br>稳定版：<a href="http://invitegiftapi.ct108.org:1505/">http://invitegiftapi.ct108.org:1505/</a><br> 正式版：<a href="http://invitegiftapi.ct108.net/">http://invitegiftapi.ct108.net/</a> <br>预发版：<a href="http://invitegiftapi.ct108.net:2505/">http://invitegiftapi.ct108.net:2505/</a></td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">Header</td>
<td style="text-align: left;">认证字段：AppKey</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">Content-Type</td>
<td style="text-align: left;">application/json;charset=utf-8</td>
<td style="text-align: left;">-</td>
</tr>
</tbody>
</table>
<h3>后端维护的接口地址</h3>
<p><a href="http://doc.uc108.org:8002/index.php?s=/page/2611">查看</a></p>
<h2>与游戏方对接需要的信息</h2>
<p><code>分享的连接需要有以下参数</code>：</p>
<table>
<thead>
<tr>
<th style="text-align: left;">字段</th>
<th style="text-align: left;">类型</th>
<th style="text-align: left;">空</th>
<th>默认</th>
<th>注释</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">openId（废弃）</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">是</td>
<td>''</td>
<td>为空：微信未授权；<br/>不为空：微信授权</td>
</tr>
<tr>
<td style="text-align: left;">userId</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">否</td>
<td></td>
<td>用户id</td>
</tr>
<tr>
<td style="text-align: left;">unionId</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">否</td>
<td></td>
<td>unionId</td>
</tr>
<tr>
<td style="text-align: left;">type</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">否</td>
<td></td>
<td>分享类型：0微信，1朋友圈</td>
</tr>
<tr>
<td style="text-align: left;">userid</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">否</td>
<td></td>
<td>玩家用户ID</td>
</tr>
<tr>
<td style="text-align: left;">gtime</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">否</td>
<td></td>
<td>玩家游戏时长</td>
</tr>
<tr>
<td style="text-align: left;">happy</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">否</td>
<td></td>
<td>玩家欢乐币</td>
</tr>
<tr>
<td style="text-align: left;">activityid</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">否</td>
<td></td>
<td>活动ID</td>
</tr>
<tr>
<td style="text-align: left;">sharetime</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">否</td>
<td></td>
<td>分享时间</td>
</tr>
<tr>
<td style="text-align: left;">sign</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">否</td>
<td></td>
<td>签名</td>
</tr>
<tr>
<td style="text-align: left;">img</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">否</td>
<td></td>
<td>头像链接</td>
</tr>
<tr>
<td style="text-align: left;">t</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">否</td>
<td></td>
<td>链接类型：0链接，1海报</td>
</tr>
<tr>
<td style="text-align: left;">page</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">否</td>
<td></td>
<td>游戏类型：0非头号赢家游戏，1头号赢家游戏</td>
</tr>
<tr>
<td style="text-align: left;">authorizetime</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">否</td>
<td></td>
<td>授权时间，直接获取本地时间</td>
</tr>
</tbody>
</table>
<h2>与后端对接需要的接口</h2>
<h3>接口1:获取活动基本信息</h3>
<p><strong>简要描述：</strong></p>
<ul>
<li>(接口介绍) </li>
</ul>
<p><strong>请求url：</strong></p>
<ul>
<li><code>http://invitegiftapi.ct108.org:1505/api/Invite/GetPageShowInfo</code></li>
</ul>
<p><strong>适用版本：</strong> </p>
<ul>
<li>[v1.0+]</li>
</ul>
<p><strong>请求方式：</strong> </p>
<p><code>get</code></p>
<p><strong>请求参数：</strong></p>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>必选</th>
<th>默认值</th>
<th>说明</th>
<th>限制长度</th>
</tr>
</thead>
<tbody>
<tr>
<td>abbr</td>
<td>string</td>
<td>是</td>
<td>""</td>
<td>游戏缩写</td>
<td>-</td>
</tr>
<tr>
<td>activityId</td>
<td>number</td>
<td>是</td>
<td>0</td>
<td>活动id</td>
<td>-</td>
</tr>
</tbody>
</table>
<p><strong>请求示例：</strong></p>
<pre><code>{
"abbr":"", //游戏缩写
"activityId":0 //活动id
}
</code></pre>
<p><strong>返回参数：</strong></p>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>说明</th>
<th>限制长度</th>
</tr>
</thead>
<tbody>
<tr>
<td>AvatarPicture</td>
<td>string</td>
<td>微信头像</td>
<td>-</td>
</tr>
<tr>
<td>Title</td>
<td>string</td>
<td>文案:头像旁的文案</td>
<td>-</td>
</tr>
<tr>
<td>GameLogo</td>
<td>string</td>
<td>游戏logo</td>
<td>-</td>
</tr>
<tr>
<td>GameName</td>
<td>string</td>
<td>游戏名</td>
<td>-</td>
</tr>
<tr>
<td>Abbr</td>
<td>string</td>
<td>游戏名缩写</td>
<td>-</td>
</tr>
<tr>
<td>InviteBgPicUrl</td>
<td>string</td>
<td>邀请的宣传图</td>
<td>-</td>
</tr>
<tr>
<td>DownLoadType</td>
<td>number</td>
<td>下载类型:区分下载包和下载页面地址</td>
<td>-</td>
</tr>
<tr>
<td>IosDownLoadUrl</td>
<td>string</td>
<td>ios下载地址或者下载页面地址</td>
<td>-</td>
</tr>
<tr>
<td>AndroidDownLoadUrl</td>
<td>string</td>
<td>Android下载地址或者下载页面地址</td>
<td>-</td>
</tr>
<tr>
<td>RuleContent</td>
<td>string</td>
<td>规则描述</td>
<td>-</td>
</tr>
<tr>
<td>PosterPicUrl</td>
<td>string</td>
<td>海报背景宣传图</td>
<td>-</td>
</tr>
<tr>
<td>InvitePicUrl</td>
<td>string</td>
<td>邀请有礼图片链接</td>
<td>-</td>
</tr>
</tbody>
</table>
<p><strong>返回示例：</strong></p>
<pre><code>{
"StatusCode": 0, //code值
"Data": { //数据
"AvatarPicture": "", // 微信头像
"Title": "", // 文案:头像旁的文案
"GameLogo": "", // 游戏logo
"GameName": "", // 游戏名
"Abbr": "", // 游戏名缩写
"InviteBgPicUrl": "", // 邀请的宣传图
"DownLoadType": 0, // 下载类型:区分下载包和下载页面地址
"IosDownLoadUrl": "", //ios下载地址或者下载页面地址
"AndroidDownLoadUrl": "", //Android下载地址或者下载页面地址
"RuleContent": "" ,//规则描述
"PosterPicUrl":"海报背景宣传图",
"InvitePicUrl": "邀请有礼图片链接"
},
"Message": ""
}</code></pre>
<h3>接口2:邀请人和受邀人关系绑定接口</h3>
<p><strong>简要描述：</strong></p>
<ul>
<li>进入页面，非头号赢家领取奖励触发</li>
</ul>
<p><strong>请求url：</strong></p>
<ul>
<li><code>http://invitegiftapi.ct108.org:1505/api/Invite/BindMapping</code></li>
</ul>
<p><strong>适用版本：</strong> </p>
<ul>
<li>[v1.0+]</li>
</ul>
<p><strong>请求方式：</strong> </p>
<p><code>post</code></p>
<p><strong>请求参数：</strong></p>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>必选</th>
<th>默认值</th>
<th>说明</th>
<th>限制长度</th>
</tr>
</thead>
<tbody>
<tr>
<td>abbr</td>
<td>string</td>
<td>是</td>
<td>""</td>
<td>游戏缩写</td>
<td>-</td>
</tr>
<tr>
<td>sourcetype</td>
<td>string</td>
<td>是</td>
<td>""</td>
<td>分享来源</td>
<td>-</td>
</tr>
<tr>
<td>inviteuid</td>
<td>number</td>
<td>是</td>
<td>0</td>
<td>邀请人用户Id</td>
<td>-</td>
</tr>
<tr>
<td>invitewxname</td>
<td>string</td>
<td>是</td>
<td>""</td>
<td>邀请人微信昵称</td>
<td>-</td>
</tr>
<tr>
<td>invitedunionid</td>
<td>number</td>
<td>是</td>
<td>0</td>
<td>受邀请人unionId</td>
<td>-</td>
</tr>
<tr>
<td>wxname</td>
<td>string</td>
<td>是</td>
<td>""</td>
<td>受邀请人昵称</td>
<td>-</td>
</tr>
<tr>
<td>gametotaltime</td>
<td>number</td>
<td>是</td>
<td>0</td>
<td>游戏时长值</td>
<td>-</td>
</tr>
<tr>
<td>happyvalue</td>
<td>number</td>
<td>是</td>
<td>0</td>
<td>欢乐点</td>
<td>-</td>
</tr>
<tr>
<td>Sign</td>
<td>string</td>
<td>是</td>
<td>""</td>
<td>签名</td>
<td>-</td>
</tr>
<tr>
<td>authorizetime</td>
<td>number</td>
<td>是</td>
<td>0</td>
<td>授权时间</td>
<td>-</td>
</tr>
<tr>
<td>sharetime</td>
<td>number</td>
<td>是</td>
<td>0</td>
<td>分享时间</td>
<td>-</td>
</tr>
<tr>
<td>activityid</td>
<td>number</td>
<td>是</td>
<td>0</td>
<td>活动id</td>
<td>-</td>
</tr>
</tbody>
</table>
<p><strong>请求示例：</strong></p>
<pre><code>{
"abbr":"", //游戏缩写
"sourcetype": "", //分享来源
"inviteuid":0, //邀请人用户Id
"invitewxname": "", //邀请人微信昵称
"invitedunionid": 0, // 受邀请人unionId
"wxname": "", //受邀请人昵称
"gametotaltime": 0, //游戏时长值
"happyvalue":0, //欢乐点
"Sign": "", //签名
"authorizetime": 0, //授权时间
"sharetime": 0, // 分享时间
"activityid": 0 // 活动id
}</code></pre>
<p>备注：签名规则按照下边的这种格式：
（“abbr&sourcetype&inviteuid&invitedunionid”,”D92B4F5BA37631F5”）.ToMD5()，游戏方直接提供</p>
<p><strong>返回参数：</strong></p>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>说明</th>
<th>限制长度</th>
</tr>
</thead>
<tbody>
<tr>
<td>Data</td>
<td>number</td>
<td>0</td>
<td>-</td>
</tr>
</tbody>
</table>
<p><strong>返回示例：</strong></p>
<pre><code>{
"StatusCode":0, //code值
"Data":0,
"Message":""
}
</code></pre>
<h3>接口3:获取APP下载地址</h3>
<p><strong>简要描述：</strong></p>
<ul>
<li>(接口介绍) </li>
</ul>
<p><strong>请求url：</strong></p>
<ul>
<li><code>http://invitegiftapi.ct108.org:1505/api/Invite/GetAppUrl</code></li>
</ul>
<p><strong>适用版本：</strong> </p>
<ul>
<li>[v1.0+]</li>
</ul>
<p><strong>请求方式：</strong> </p>
<p><code>get</code></p>
<p><strong>请求参数：</strong></p>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>必选</th>
<th>默认值</th>
<th>说明</th>
<th>限制长度</th>
</tr>
</thead>
<tbody>
<tr>
<td>abbr</td>
<td>string</td>
<td>是</td>
<td>""</td>
<td>游戏缩写</td>
<td>-</td>
</tr>
<tr>
<td>activityid</td>
<td>number</td>
<td>是</td>
<td>""</td>
<td>活动id</td>
<td>-</td>
</tr>
</tbody>
</table>
<p><strong>请求示例：</strong></p>
<pre><code>{
"abbr":"", //游戏缩写
"activityid": "" //游戏id
}</code></pre>
<p><strong>返回参数：</strong></p>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>说明</th>
<th>限制长度</th>
</tr>
</thead>
<tbody>
<tr>
<td>DownLoadType</td>
<td>number</td>
<td>下载类型:0下载包地址,1下载页面地址</td>
<td>-</td>
</tr>
<tr>
<td>IosDownLoadUrl</td>
<td>string</td>
<td>ios下载包或者下载页面地址</td>
<td>-</td>
</tr>
<tr>
<td>AndroidDownLoadUrl</td>
<td>string</td>
<td>安装下载包或者下载页面地址</td>
<td>-</td>
</tr>
</tbody>
</table>
<p><strong>返回示例：</strong></p>
<pre><code>{
"StatusCode":0, //code值
"Data":{ //数据
"DownLoadType": 0, // 下载类型:0下载包地址,1下载页面地址
"IosDownLoadUrl": "", // ios下载包 或者 下载页面地址
"AndroidDownLoadUrl": "" // 安装下载包 或者 下载页面地址
},
"Message":""
}
</code></pre>
<p>备注：这个接口不区分活动的状态，如是否在活动期间！</p>
<h3>接口4:领奖接口</h3>
<p><strong>简要描述：</strong></p>
<ul>
<li>(接口介绍) </li>
</ul>
<p><strong>请求url：</strong></p>
<ul>
<li><code>http://invitegiftapi.ct108.org:1505/api/Invite/IsAward</code></li>
</ul>
<p><strong>适用版本：</strong> </p>
<ul>
<li>[v1.0+]</li>
</ul>
<p><strong>请求方式：</strong> </p>
<p><code>get</code></p>
<p><strong>请求参数：</strong></p>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>必选</th>
<th>默认值</th>
<th>说明</th>
<th>限制长度</th>
</tr>
</thead>
<tbody>
<tr>
<td>abbr</td>
<td>string</td>
<td>是</td>
<td>""</td>
<td>游戏缩写</td>
<td>-</td>
</tr>
<tr>
<td>userId</td>
<td>number</td>
<td>是</td>
<td>0</td>
<td>用户id</td>
<td>-</td>
</tr>
<tr>
<td>unionId</td>
<td>string</td>
<td>是</td>
<td>""</td>
<td>微信unionId</td>
<td>-</td>
</tr>
<tr>
<td>Type</td>
<td>number</td>
<td>是</td>
<td>""</td>
<td>0非头号赢家，1头号赢家</td>
<td>-</td>
</tr>
<tr>
<td>ActivityId</td>
<td>number</td>
<td>是</td>
<td>0</td>
<td>活动id</td>
<td>-</td>
</tr>
</tbody>
</table>
<p><strong>请求示例：</strong></p>
<pre><code>{
"abbr":"", //游戏缩写
"userId":0, //用户id
"unionId":"", //微信unionId
"type":0 ,// 0非头号赢家，1头号赢
"activityId":0 // 活动id
}
</code></pre>
<p><strong>返回参数：</strong></p>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>说明</th>
<th>限制长度</th>
</tr>
</thead>
<tbody>
<tr>
<td>AwardTip</td>
<td>string</td>
<td>奖励</td>
<td>-</td>
</tr>
<tr>
<td>- Gifts</td>
<td>array</td>
<td>-</td>
</tr>
<tr>
<td>ItemID</td>
<td>number</td>
<td>-</td>
</tr>
<tr>
<td>Number</td>
<td>number</td>
<td>-</td>
</tr>
<tr>
<td>Name</td>
<td>string</td>
<td>-</td>
</tr>
<tr>
<td>UnitName</td>
<td>string</td>
<td>-</td>
</tr>
</tbody>
</table>
<p><strong>返回示例：</strong></p>
<pre><code>{
"StatusCode":0, //code值
"Data":{ //数据
"AwardTip":"dsa",
"Gifts": [{
"ItemID": 21617,
"Number": 10,
"Name": "欢乐币",
"UnitName": "张"
}]
},
"Message":""
}
</code></pre>
<p>备注：
已领过奖：StatusCode的值101
领奖失败：StatusCode的值102</p>