API文档--v1.9


卡券提取接口

<h5>接口描述</h5> <ul> <li>接口方向:接入方 → 本平台</li> <li>限速控制:100请求/s/IP(可联系技术调整)</li> <li>适用于卡密、链接形式的卡密提取业务</li> </ul> <h5>请求URL</h5> <ul> <li>http(https)://IP:端口/api/card/get</li> </ul> <h5>请求方式</h5> <ul> <li>POST(application/x-www-form-urlencoded)</li> </ul> <h5>请求参数</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必填</th> <th style="text-align: left;">示例</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">appId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">4Kq9U9rVFz</td> <td>应用ID</td> </tr> <tr> <td style="text-align: left;">outOrderId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">cy1017010101010101</td> <td>接入方订单ID,长度&lt;=50,[幂等性说明](<a href="https://www.showdoc.com.cn/2167197494741781/9729869062769459">https://www.showdoc.com.cn/2167197494741781/9729869062769459</a> &quot;幂等性说明&quot;)</td> </tr> <tr> <td style="text-align: left;">itemId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">101</td> <td>商品ID</td> </tr> <tr> <td style="text-align: left;">itemFace</td> <td style="text-align: left;">-</td> <td style="text-align: left;">10</td> <td>商品面值(单位:元)用于校验避免配置失误造成损失,为空则不检验</td> </tr> <tr> <td style="text-align: left;">itemPrice</td> <td style="text-align: left;">-</td> <td style="text-align: left;">5.122</td> <td>商品单价(单位:元,精确到小数点后3位,不需要末尾补0)用于校验避免配置失误造成损失,为空则不检验</td> </tr> <tr> <td style="text-align: left;">amount</td> <td style="text-align: left;">是</td> <td style="text-align: left;">1</td> <td>提卡数量,对应商品是否支持单次提取多个请咨询商务</td> </tr> <tr> <td style="text-align: left;">supplyMode</td> <td style="text-align: left;">-</td> <td style="text-align: left;">0</td> <td>供货模式(可选参数)&lt;br/&gt;缺省:根据商品同异步属性决定是下单时是否返回卡密信息&lt;br/&gt;0:异步供货,卡密数据将以回调或查单形式返回,下单的响应不包含(同步商品亦支持异步提取) &lt;br/&gt;1:同步供货,下单的响应返回卡密数据,如果该商品不支持同步供货,则返回提卡失败</td> </tr> <tr> <td style="text-align: left;">callbackUrl</td> <td style="text-align: left;">-</td> <td style="text-align: left;"><a href="http://www.xx.cn/receipt">http://www.xx.cn/receipt</a></td> <td>卡券信息回调地址,异步供货时请传此参数</td> </tr> <tr> <td style="text-align: left;">timestamp</td> <td style="text-align: left;">是</td> <td style="text-align: left;">20160311154602111</td> <td>时间戳,格式:yyyyMMddHHmmssSSS</td> </tr> <tr> <td style="text-align: left;">phoneNo</td> <td style="text-align: left;">-</td> <td style="text-align: left;">18888888888</td> <td>手机号,可选参数,少部分卡券商品需要用户号码</td> </tr> <tr> <td style="text-align: left;">ext1</td> <td style="text-align: left;">-</td> <td style="text-align: left;">-</td> <td>扩展参数1</td> </tr> <tr> <td style="text-align: left;">ext2</td> <td style="text-align: left;">-</td> <td style="text-align: left;">-</td> <td>扩展参数2</td> </tr> <tr> <td style="text-align: left;">ext3</td> <td style="text-align: left;">-</td> <td style="text-align: left;">-</td> <td>扩展参数3</td> </tr> <tr> <td style="text-align: left;">sign</td> <td style="text-align: left;">是</td> <td style="text-align: left;">tmE36C00Hzbj1TF2fFuAAR……</td> <td>签名,[签名算法](<a href="https://www.showdoc.cc/900133176881927?page_id=4798471163226341">https://www.showdoc.cc/900133176881927?page_id=4798471163226341</a> &quot;签名算法&quot;)</td> </tr> </tbody> </table> <h4><em>注意:</em></h4> <ul> <li>如不能保证每次调用下单接口时outOrderId的历史<strong>唯一性</strong>,请阅读“幂等性说明”章节。</li> </ul> <h4>返回格式:json</h4> <ul> <li>当itemId对应商品不支持同步供货时,只返回前5个参数,卡券信息通过回调返回,也可通过查询接口主动查询。</li> </ul> <h4>返回参数</h4> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必填</th> <th style="text-align: left;">示例</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">code</td> <td style="text-align: left;">是</td> <td style="text-align: left;">00</td> <td>请求结果,请看结果码章节</td> </tr> <tr> <td style="text-align: left;">msg</td> <td style="text-align: left;">是</td> <td style="text-align: left;">下单成功/提取成功/失败原因</td> <td>结果详细描</td> </tr> <tr> <td style="text-align: left;">orderId</td> <td style="text-align: left;">-</td> <td style="text-align: left;">201701010101010001</td> <td>平台订单号</td> </tr> <tr> <td style="text-align: left;">outOrderId</td> <td style="text-align: left;">-</td> <td style="text-align: left;">cy1017010101010101</td> <td>接入方订单号</td> </tr> <tr> <td style="text-align: left;">cost</td> <td style="text-align: left;">-</td> <td style="text-align: left;">10.355</td> <td>本次总消费,单位(元)</td> </tr> <tr> <td style="text-align: left;">cardData</td> <td style="text-align: left;">-</td> <td style="text-align: left;">json数组</td> <td>卡券信息</td> </tr> <tr> <td style="text-align: left;">cardName</td> <td style="text-align: left;">是</td> <td style="text-align: left;">xxx5元官方优惠券</td> <td>卡卷名称</td> </tr> <tr> <td style="text-align: left;">cardType</td> <td style="text-align: left;">是</td> <td style="text-align: left;">LINK</td> <td>卡券形式:&lt;br/&gt;LINK 链接&lt;br/&gt;PICTURE 券码+链接&lt;br/&gt;NUMBER_PASSWORD 卡号+密码&lt;br/&gt;PASSWORD 密码</td> </tr> <tr> <td style="text-align: left;">cardNo</td> <td style="text-align: left;">-</td> <td style="text-align: left;">-</td> <td>卡号(卡券形式为NUMBER_PASSWORD时有值),[解密算法](<a href="https://www.showdoc.cc/900133176881927?page_id=4798471163226341">https://www.showdoc.cc/900133176881927?page_id=4798471163226341</a> &quot;签名算法&quot;)</td> </tr> <tr> <td style="text-align: left;">cardPwd</td> <td style="text-align: left;">-</td> <td style="text-align: left;">-</td> <td>密码(卡券类型为NUMBER_PASSWORD、PASSWORD、PICTURE时有值),[解密算法](<a href="https://www.showdoc.cc/900133176881927?page_id=4798471163226341">https://www.showdoc.cc/900133176881927?page_id=4798471163226341</a> &quot;签名算法&quot;)</td> </tr> <tr> <td style="text-align: left;">cardLink</td> <td style="text-align: left;">-</td> <td style="text-align: left;">-</td> <td>链接(卡券形式为LINK或PICTURE时有值),[解密算法](<a href="https://www.showdoc.cc/900133176881927?page_id=4798471163226341">https://www.showdoc.cc/900133176881927?page_id=4798471163226341</a> &quot;签名算法&quot;)</td> </tr> <tr> <td style="text-align: left;">expireTime</td> <td style="text-align: left;">-</td> <td style="text-align: left;">2016-03-11 15:46:01</td> <td>卡券有效期,格式:yyyy-MM-dd HH:mm:ss</td> </tr> </tbody> </table> <h4><em>注意:</em></h4> <ul> <li>code为00时表示下单成功,code为-16、-22、-23、-99、接口调用超时<strong>存疑处理</strong>(调用查单接口查询或与客服确认)。</li> <li>cardNo、cardPwd、cardLink为加密参数,请参照[解密算法](<a href="https://www.showdoc.cc/900133176881927?page_id=4798471163226341">https://www.showdoc.cc/900133176881927?page_id=4798471163226341</a> &quot;签名算法&quot;) |</li> </ul> <h5>返回示例</h5> <ul> <li> <p>异步供货时:</p> <pre><code>{ &amp;quot;code&amp;quot;:&amp;quot;00&amp;quot;, &amp;quot;msg&amp;quot;:&amp;quot;下单成功&amp;quot;, &amp;quot;orderId&amp;quot;:&amp;quot;201701010101010001&amp;quot;, &amp;quot;outOrderId&amp;quot;:&amp;quot;cy1017010101010101&amp;quot;, &amp;quot;cost&amp;quot;:&amp;quot;10.335&amp;quot; }</code></pre> </li> <li> <p>同步供货时:</p> <pre><code>{ &amp;quot;code&amp;quot;: &amp;quot;00&amp;quot;, &amp;quot;msg&amp;quot;: &amp;quot;提卡成功&amp;quot;, &amp;quot;orderId&amp;quot;: &amp;quot;201701010101010001&amp;quot;, &amp;quot;outOrderId&amp;quot;: &amp;quot;cy1017010101010101&amp;quot;, &amp;quot;cost&amp;quot;: &amp;quot;10.335&amp;quot;, &amp;quot;cardData&amp;quot;: [ { &amp;quot;cardName&amp;quot;: &amp;quot;xxx5元官方优惠券&amp;quot;, &amp;quot;cardType&amp;quot;: &amp;quot;NUMBER_PASSWORD&amp;quot;, &amp;quot;cardNo&amp;quot;: &amp;quot;1dM/tmE36C00Hzbj1TF2fFuAAR……&amp;quot;, &amp;quot;cardPwd&amp;quot;: &amp;quot;1dM/tmE36C00Hzbj1TF2fFuAAR……&amp;quot;, &amp;quot;expireTime&amp;quot;: &amp;quot;2016-03-11 15:46:01&amp;quot; }, { &amp;quot;cardName&amp;quot;: &amp;quot;xxx5元官方优惠券&amp;quot;, &amp;quot;cardType&amp;quot;: &amp;quot;NUMBER_PASSWORD&amp;quot;, &amp;quot;cardNo&amp;quot;: &amp;quot;1dM/tmE36C00Hzbj1TF2fFuAAR……&amp;quot;, &amp;quot;cardPwd&amp;quot;: &amp;quot;1dM/tmE36C00Hzbj1TF2fFuAAR……&amp;quot;, &amp;quot;expireTime&amp;quot;: &amp;quot;2016-03-11 15:46:01&amp;quot; } ] } </code></pre> </li> </ul>

页面列表

ITEM_HTML