2、API充值接口设置
<p>【文档修改日期：2021年3月8日】</p>
<h5>简要描述</h5>
<ul>
<li>本接口是将拼多多的订单数据，提交到充值平台，下面根据设置中的内容，逐项预以说明。
<img src="https://www.showdoc.com.cn/server/api/attachment/visitfile/sign/49858f009baa06de5631d9ba54e04936" alt="" /></li>
</ul>
<h5>接口名称</h5>
<ul>
<li>这里填写您对接的平台或网站的名称，您可以根据情况随意填写，如果对接多个平台，用于区分不同平台。</li>
<li>新设置一个接口名称，然后点击最下方的【添加为新接口】按钮，则新增一个接口设置。</li>
</ul>
<h5>提交地址(URL)</h5>
<ul>
<li>这里填写平台订单充值接口的网址（或说URL）。</li>
<li>提交地址支持支持右侧可用变量中显示的大部分变量（关于变量的使用见后面详述）。
填写示例： <code>http://gateway.xxxx.com/api/Pay</code></li>
</ul>
<h5>提交内容（Request Body）</h5>
<ul>
<li>这里设置充值平台的各项提交参数，右侧所有变量都可以支持。</li>
<li>可以使用常规的URL网址格式，如下：
<pre><code>userid=【你的用户名】&userpws=【加密密码】&cardid=140101&cardnum={平台商品编号}&sporder_id={订单编号}&sporder_time={订单时间A}&game_userid={充值号码}&md5_str={md5校验}&version=6.0</code></pre></li>
<li>也可以使用json格式，如下：
<pre><code>{
"acctType": null,
"merchantCode": "【系统商户号】",
"faceValue": "{商品面值}",
"goodsCode": "{平台商品编号}",
"goodsNum": {购买数量},
"sign": "{md5校验}",
"userName": "{充值号码}",
"orderNo": "{订单编号}"
}</code></pre></li>
</ul>
<h5>协议头（Request Head）</h5>
<ul>
<li>这里填写充值平台需要的协议头（大部分充值平台不需要，保持为空就可以），协议头格式为一行一条，如下示例：
<pre><code>Content-Type: application/json;charset=UTF-8
Accept-Language: zh-CN,zh;q=0.9,und;q=0.8</code></pre></li>
</ul>
<h5>签名校验项目</h5>
<ul>
<li>这里填写签名校验的原始文本，是{md5校验}、{md5校验UTF8}、{sha1校验}等变量的数据来源。也就是说，签名校验项目内容进行md5后，就是变量{md5校验}，这个变量可以用到提交内容（Request Body）里面。如果充值平台的md5要求大写，则把本项目上方的【校验项目结果到大写】对勾勾选，不勾选则为小写。
校验项目填写示例如下：
填写示例： <code>【系统商户号】{订单编号}{平台商品编号}{购买数量}【key】</code></li>
</ul>
<h5>数据提交方式</h5>
<ul>
<li>数据提交方式即网页访问方式，共两个选项，选择【POST方式】提交时，软件将【提交内容（Request Body）】里面填写的内容通过POST方式提交到平台。选择【GET方式】时，软件将【提交内容（Request Body）】 使用问号(?)连接到提交地址后面，然后以GET方式提交到网站。</li>
<li>一般充值平台都兼容这两种提交方式，默认可选择POST方式。</li>
</ul>
<h5>提交中文编码方式</h5>
<ul>
<li>这里选择一些中文变量提交到网站的方式，一般情况下充值平台用不到中文，这里一般选择【不进行编码】，如果平台强制要求，您可以按平台要求选择编码方式。</li>
</ul>
<h5>可用变量说明</h5>
<ul>
<li>软件取得的拼多多数据，将以变量形式填写到上面所需的提交地址、提交内容、协议头等内容里。</li>
<li>淘小秘变量的格式，是使用英文的{}括起来。</li>
<li>淘小秘在提供填写示范里，里面有【】括起来的内容，这里通常是指需要填写充值平台的固定参数，比如平台用户名、Appkey等，请替换这些内容后，把【】字符本身再去掉。</li>
<li>下面是提交充值接口支持的变量说明： </li>
</ul>
<table>
<thead>
<tr>
<th style="text-align: left;">变量名</th>
<th style="text-align: left;">示例</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">{订单编号}</td>
<td style="text-align: left;">210113-449122305100358</td>
<td>拼多多的订单编号</td>
</tr>
<tr>
<td style="text-align: left;">{订单编号A}</td>
<td style="text-align: left;">210113449122305100358</td>
<td>纯数字的订单编号（个别网站订单编号不允许有字符，则可使用本变量）密码</td>
</tr>
<tr>
<td style="text-align: left;">{商品名称}</td>
<td style="text-align: left;">中国移动10元话费充值</td>
<td>拼多多商品的名称</td>
</tr>
<tr>
<td style="text-align: left;">{商品简称}</td>
<td style="text-align: left;">移动10元</td>
<td>在淘小秘中设置的发货商品简称，您可以将此商品简称作为对接充值平台的商品的一个变量。</td>
</tr>
<tr>
<td style="text-align: left;">{商品ID}</td>
<td style="text-align: left;">220152070197</td>
<td>平台商品ID</td>
</tr>
<tr>
<td style="text-align: left;">{平台商品编号}</td>
<td style="text-align: left;">1583</td>
<td>重要提示：这里是拼多多商品与充值平台商品进行识别关联的桥梁。这里是需对接的充值平台的商品编号，这个编号是在软件的【设置发货商品】窗口设置的。</td>
</tr>
<tr>
<td style="text-align: left;">{商品面值}</td>
<td style="text-align: left;">50</td>
<td>这里是需对接的充值平台的商品面值，是在软件的【设置发货商品】窗口设置的。部分商品不需要。</td>
</tr>
<tr>
<td style="text-align: left;">{SKU编号}</td>
<td style="text-align: left;">15837775</td>
<td>拼多多商品SKU的编号。注意，此数据仅在应用授权的情况下可获得，建议不要使用本变量来关联平台商品。</td>
</tr>
<tr>
<td style="text-align: left;">{SKU名称}</td>
<td style="text-align: left;">中国移动10元</td>
<td>拼多多商品SKU的名称</td>
</tr>
<tr>
<td style="text-align: left;">{购买数量}</td>
<td style="text-align: left;">1</td>
<td>拼多多订单的购买数量</td>
</tr>
<tr>
<td style="text-align: left;">{发货数量}</td>
<td style="text-align: left;">3</td>
<td>使用了倍数发货功能后，重新计算的发货数量，发货数量=购买数量×倍数</td>
</tr>
<tr>
<td style="text-align: left;">{订单金额}</td>
<td style="text-align: left;">3.85</td>
<td>拼多多订单的金额</td>
</tr>
<tr>
<td style="text-align: left;">{充值号码}</td>
<td style="text-align: left;">1357777XXXX</td>
<td>拼多多订单的充值号码</td>
</tr>
<tr>
<td style="text-align: left;">{订单备注}</td>
<td style="text-align: left;">备注内容</td>
<td>拼多多订单中填写的备注内容</td>
</tr>
<tr>
<td style="text-align: left;">{时间戳}</td>
<td style="text-align: left;">1614778835153</td>
<td>13位到毫秒的时间戳</td>
</tr>
<tr>
<td style="text-align: left;">{时间戳10位}</td>
<td style="text-align: left;">1614778835</td>
<td>10位到秒的时间戳</td>
</tr>
<tr>
<td style="text-align: left;">{时间戳A}</td>
<td style="text-align: left;">20210308152301</td>
<td>时间格式：yyyyMMddHHmmss</td>
</tr>
<tr>
<td style="text-align: left;">{时间戳B}</td>
<td style="text-align: left;">2021-03-08 15:23:01</td>
<td>时间格式：yyyy-MM-dd HH:mm:ss</td>
</tr>
<tr>
<td style="text-align: left;">{订单时间A}</td>
<td style="text-align: left;">202005292359</td>
<td>订单时间的格式：yyyyMMddHHmm</td>
</tr>
<tr>
<td style="text-align: left;">{md5校验}</td>
<td style="text-align: left;">e10adc3949ba59abbe56e057f20f883e</td>
<td>签名校验项目进行md5编码的值</td>
</tr>
<tr>
<td style="text-align: left;">{md5校验UTF8}</td>
<td style="text-align: left;">2537e27184fef4f1e7bd717b1ac482e7</td>
<td>签名校验项目先进行UTF8编号后再进行md5编码的值，适用于签名项目带中文的情况。</td>
</tr>
<tr>
<td style="text-align: left;">{sha1校验}</td>
<td style="text-align: left;">7c4a8d09ca3762af61e59520943dc26494f8941b</td>
<td>校验项目进行sha1编码后的值</td>
</tr>
</tbody>
</table>
<ul>
<li>另外，{卡密内容}、{发货说明}、{店铺ID}、{客户ID}等变量应用较少，不再一一说明。</li>
</ul>
<h5>返回信息处理</h5>
<ul>
<li>这里设置根据充值平台返回的信息进行相应处理选择。（注：充值平台返回的软件，软件会按照UTF8格式来进行处理）。
以下面的返回信息举例说明这里的处理：</li>
</ul>
<pre><code>{"code":0,"message":"成功提交","data":{"orderid":"ebc5ead58c034a43bbbbca3006c80c7e", "mobile":"13735891311", "resptime":"20200706171641"}}</code></pre>
<ul>
<li>
<p>1、处理发货方法：共有以下3种选择：
<img src="https://www.showdoc.com.cn/server/api/attachment/visitfile/sign/625a5ac981a6a53f4c26ea38a7a42b90" alt="" />
常用的是第3项，即【调用成功时后台暂不发货，待查询接口成功后发货】。</p>
</li>
<li>
<p>2、包含右侧关键词视为提交成功：这里填写成功关键词，如果填写后返回消息没有此关键词，则软件将该订单作为调用失败处理，加入到异常订单。比如上面返回示例，成功关键词可以填：<code>成功提交</code>，也可以填<code>"code":0</code></p>
</li>
<li>3、取三方平台订单号JSON/XML值公式：这里的三方平台订单号是指充值平台的订单号，如果充值平台查询订单时需要提供平台的订单号，则需要提前在提交充值返回的消息中取得三方订单号，这里的公式是平台返回消息是JSON格式时，用小数点隔开的各级次的属性名，如以上示例中取订单号的公式为：<code>data.orderid</code></li>
</ul>
<h5>关于测试提交</h5>
<ul>
<li>由于测试提交时，部分订单数据获取不全，所以更建议您使用真实订单来测试功能。</li>
<li>如果您在测试中失败，该笔订单会自动添加到异常订单，只要您到软件的【订单管理/异常订单】，删除相关的记录后再重新开启发货，软件会重新进行提交充值。</li>
<li>正常情况下，软件处理成功后，会将订单加下到【订单管理/售后订单】中，您可以到这里查询订单的状态（包括后续查询接口有问题，应首先查询软件中记录的订单状态），一般刚提交的订单状态为：<code>已发货，待API查询结果</code>。如果状态中没有显示待API查询，则检查一下API接口的总开关有没有打开。</li>
</ul>