Skip to content

P
pmdm-doc
Commit 33f654dd by eva
Options

pmdm内部文档

parents
Showing with 245 additions and 0 deletions
PMDM-API_内部_v0.1.html 0 → 100755
<!DOCTYPE html>
<!DOCTYPE html>
<html class="theme theme-white">
<head>
<meta charset="utf-8">
<title>Payment Master Data Management API 内部</title>
<link href="https://www.zybuluo.com/static/assets/template-theme-white.css" rel="stylesheet" media="screen">
<style type="text/css">
#wmd-preview h1 {
color: #0077bb; /* 将标题改为蓝色 */
}</style>
</head>
<body class="theme theme-white">
<div id="wmd-preview" class="wmd-preview wmd-preview-full-reader"><div class="md-section-divider"></div><div class="md-section-divider"></div><h1 data-anchor-id="267u" id="payment-master-data-management-api-内部">Payment Master Data Management API 内部</h1><table data-anchor-id="j9gk" class="table table-striped-white table-bordered">
<thead>
<tr>
<th style="text-align:center;">版本</th>
<th style="text-align:center;">修订内容</th>
<th style="text-align:center;">修订原因</th>
<th style="text-align:center;">编写时间</th>
<th style="text-align:center;">作者</th>
</tr>
</thead>
<tbody><tr>
<td style="text-align:center;">v0.1</td>
<td style="text-align:center;">创建</td>
<td style="text-align:center;"></td>
<td style="text-align:center;">2018-03-01</td>
<td style="text-align:center;">宦传建</td>
</tr>
</tbody></table><blockquote data-anchor-id="pfq5" class="white-blockquote">
<p>以下简称 PMDM</p>
</blockquote><p data-anchor-id="thdb"><div class="toc"><div class="toc">
<ul>
<li><a href="#payment-master-data-management-api-内部">Payment Master Data Management API 内部</a><ul>
<li><ul>
<li><a href="#接口说明">接口说明</a></li>
</ul>
</li>
<li><a href="#获取下发渠道列表">获取下发渠道列表</a><ul>
<li><ul>
<li><a href="#请求参数">请求参数</a></li>
<li><a href="#响应参数">响应参数</a></li>
<li><a href="#响应示例">响应示例</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#推送门店数据">推送门店数据</a><ul>
<li><ul>
<li><a href="#请求参数-1">请求参数</a></li>
<li><a href="#响应参数-1">响应参数</a></li>
<li><a href="#请求示例">请求示例</a></li>
<li><a href="#响应示例-1">响应示例</a></li>
</ul>
</li>
<li><a href="#返回码表">返回码表</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</p><div class="md-section-divider"></div><h3 data-anchor-id="zgcu" id="接口说明">接口说明</h3><ul data-anchor-id="5kl7">
<li>API 请求响应数据格式目前支持 <code>JSON</code> 格式，编码均为 <code>UTF-8</code> 。</li>
</ul><div class="md-section-divider"></div><h2 data-anchor-id="s66g" id="获取下发渠道列表">获取下发渠道列表</h2><p data-anchor-id="jf5o">GET /getDeliverChannel</p><div class="md-section-divider"></div><h4 data-anchor-id="6hj0" id="请求参数">请求参数</h4><p data-anchor-id="1qyl">无</p><div class="md-section-divider"></div><h4 data-anchor-id="2gld" id="响应参数">响应参数</h4><table data-anchor-id="2qt9" class="table table-striped-white table-bordered">
<thead>
<tr>
<th style="text-align:left;">字段</th>
<th style="text-align:center;">类型</th>
<th style="text-align:center;">是否必填</th>
<th style="text-align:center;">备注</th>
</tr>
</thead>
<tbody><tr>
<td style="text-align:left;">code</td>
<td style="text-align:center;">Integer</td>
<td style="text-align:center;">是</td>
<td style="text-align:center;">返回码</td>
</tr>
<tr>
<td style="text-align:left;">msg</td>
<td style="text-align:center;">String</td>
<td style="text-align:center;">是</td>
<td style="text-align:center;">返回码描述</td>
</tr>
<tr>
<td style="text-align:left;">channels</td>
<td style="text-align:center;">Array</td>
<td style="text-align:center;">是</td>
<td style="text-align:center;">下发渠道列表</td>
</tr>
<tr>
<td style="text-align:left;">└ id</td>
<td style="text-align:center;">Integer</td>
<td style="text-align:center;">是</td>
<td style="text-align:center;">渠道号</td>
</tr>
<tr>
<td style="text-align:left;">└ name</td>
<td style="text-align:center;">String</td>
<td style="text-align:center;">是</td>
<td style="text-align:center;">渠道名称</td>
</tr>
</tbody></table><div class="md-section-divider"></div><h4 data-anchor-id="pg9p" id="响应示例">响应示例</h4><div class="md-section-divider"></div><pre class="prettyprint linenums prettyprinted" data-anchor-id="3aeq" style=""><ol class="linenums"><li class="L0"><code class="language-json"><span class="pun">{</span></code></li><li class="L1"><code class="language-json"><span class="pln"> </span><span class="str">"code"</span><span class="pun">:</span><span class="pln"> </span><span class="lit">100</span><span class="pun">,</span></code></li><li class="L2"><code class="language-json"><span class="pln"> </span><span class="str">"msg"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"成功"</span><span class="pun">,</span></code></li><li class="L3"><code class="language-json"><span class="pln"> </span><span class="str">"channels"</span><span class="pun">:</span><span class="pln"> </span><span class="pun">[</span></code></li><li class="L4"><code class="language-json"><span class="pln"> </span><span class="pun">{</span></code></li><li class="L5"><code class="language-json"><span class="pln"> </span><span class="str">"id"</span><span class="pun">:</span><span class="pln"> </span><span class="lit">1001</span><span class="pun">,</span></code></li><li class="L6"><code class="language-json"><span class="pln"> </span><span class="str">"name"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"对账平台"</span></code></li><li class="L7"><code class="language-json"><span class="pln"> </span><span class="pun">},</span></code></li><li class="L8"><code class="language-json"><span class="pln"> </span><span class="pun">{</span></code></li><li class="L9"><code class="language-json"><span class="pln"> </span><span class="str">"id"</span><span class="pun">:</span><span class="pln"> </span><span class="lit">1002</span><span class="pun">,</span></code></li><li class="L0"><code class="language-json"><span class="pln"> </span><span class="str">"name"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"upp"</span></code></li><li class="L1"><code class="language-json"><span class="pln"> </span><span class="pun">}</span></code></li><li class="L2"><code class="language-json"><span class="pln"> </span><span class="pun">//</span><span class="pln"> </span><span class="pun">...</span></code></li><li class="L3"><code class="language-json"><span class="pln"> </span><span class="pun">]</span></code></li><li class="L4"><code class="language-json"><span class="pun">}</span></code></li></ol></pre><div class="md-section-divider"></div><h2 data-anchor-id="msqi" id="推送门店数据">推送门店数据</h2><p data-anchor-id="eyi0">POST /pushStore</p><div class="md-section-divider"></div><h4 data-anchor-id="5o6j" id="请求参数-1">请求参数</h4><table data-anchor-id="kldp" class="table table-striped-white table-bordered">
<thead>
<tr>
<th style="text-align:left;">字段</th>
<th style="text-align:center;">类型</th>
<th style="text-align:center;">是否必填</th>
<th style="text-align:center;">备注</th>
</tr>
</thead>
<tbody><tr>
<td style="text-align:left;">isAll</td>
<td style="text-align:center;">Integer</td>
<td style="text-align:center;">是</td>
<td style="text-align:center;">是否全选所有渠道：1-是，0-否</td>
</tr>
<tr>
<td style="text-align:left;">channels</td>
<td style="text-align:center;">Array</td>
<td style="text-align:center;">是</td>
<td style="text-align:center;">渠道号列表(注：如果全选，该字段为空)</td>
</tr>
<tr>
<td style="text-align:left;">from</td>
<td style="text-align:center;">Integer</td>
<td style="text-align:center;">是</td>
<td style="text-align:center;">区分 gc 和 ec 的门店，1-gc, 2-ec</td>
</tr>
<tr>
<td style="text-align:left;">data</td>
<td style="text-align:center;">Array</td>
<td style="text-align:center;">是</td>
<td style="text-align:center;">门店数据列表</td>
</tr>
<tr>
<td style="text-align:left;">└ province</td>
<td style="text-align:center;">String</td>
<td style="text-align:center;">是</td>
<td style="text-align:center;">省份</td>
</tr>
<tr>
<td style="text-align:left;">└ city</td>
<td style="text-align:center;">String</td>
<td style="text-align:center;">是</td>
<td style="text-align:center;">城市</td>
</tr>
<tr>
<td style="text-align:left;">└ company</td>
<td style="text-align:center;">String</td>
<td style="text-align:center;">是</td>
<td style="text-align:center;">法人公司</td>
</tr>
<tr>
<td style="text-align:left;">└ id</td>
<td style="text-align:center;">String</td>
<td style="text-align:center;">是</td>
<td style="text-align:center;">门店号</td>
</tr>
<tr>
<td style="text-align:left;">└ name</td>
<td style="text-align:center;">String</td>
<td style="text-align:center;">是</td>
<td style="text-align:center;">门店名称</td>
</tr>
<tr>
<td style="text-align:left;">└ addr</td>
<td style="text-align:center;">String</td>
<td style="text-align:center;">是</td>
<td style="text-align:center;">门店地址</td>
</tr>
<tr>
<td style="text-align:left;">└ manager</td>
<td style="text-align:center;">String</td>
<td style="text-align:center;">是</td>
<td style="text-align:center;">门店经理姓名</td>
</tr>
<tr>
<td style="text-align:left;">└ managerPhone</td>
<td style="text-align:center;">String</td>
<td style="text-align:center;">是</td>
<td style="text-align:center;">门店经理电话</td>
</tr>
<tr>
<td style="text-align:left;">└ email</td>
<td style="text-align:center;">String</td>
<td style="text-align:center;">是</td>
<td style="text-align:center;">门店邮箱</td>
</tr>
<tr>
<td style="text-align:left;">└ phone</td>
<td style="text-align:center;">String</td>
<td style="text-align:center;">是</td>
<td style="text-align:center;">门店电话</td>
</tr>
<tr>
<td style="text-align:left;">└ posNum</td>
<td style="text-align:center;">Integer</td>
<td style="text-align:center;">是</td>
<td style="text-align:center;">门店pos数量</td>
</tr>
</tbody></table><div class="md-section-divider"></div><h4 data-anchor-id="cd5z" id="响应参数-1">响应参数</h4><table data-anchor-id="osvo" class="table table-striped-white table-bordered">
<thead>
<tr>
<th style="text-align:left;">字段</th>
<th style="text-align:center;">类型</th>
<th style="text-align:center;">是否必填</th>
<th style="text-align:center;">备注</th>
</tr>
</thead>
<tbody><tr>
<td style="text-align:left;">code</td>
<td style="text-align:center;">Integer</td>
<td style="text-align:center;">是</td>
<td style="text-align:center;">返回码</td>
</tr>
<tr>
<td style="text-align:left;">msg</td>
<td style="text-align:center;">String</td>
<td style="text-align:center;">是</td>
<td style="text-align:center;">返回码描述</td>
</tr>
</tbody></table><div class="md-section-divider"></div><h4 data-anchor-id="k8ew" id="请求示例">请求示例</h4><div class="md-section-divider"></div><pre class="prettyprint linenums prettyprinted" data-anchor-id="g6hw" style=""><ol class="linenums"><li class="L0"><code class="language-json"><span class="pun">{</span></code></li><li class="L1"><code class="language-json"><span class="pln"> </span><span class="str">"isAll"</span><span class="pun">:</span><span class="pln"> </span><span class="lit">0</span><span class="pun">,</span></code></li><li class="L2"><code class="language-json"><span class="pln"> </span><span class="str">"channels"</span><span class="pun">:</span><span class="pln"> </span><span class="pun">[</span><span class="lit">1001</span><span class="pun">,</span><span class="pln"> </span><span class="lit">1002</span><span class="pun">],</span></code></li><li class="L3"><code class="language-json"><span class="pln"> </span><span class="str">"from"</span><span class="pun">:</span><span class="pln"> </span><span class="lit">2</span><span class="pun">,</span></code></li><li class="L4"><code class="language-json"><span class="pln"> </span><span class="str">"data"</span><span class="pun">:</span><span class="pln"> </span><span class="pun">[</span></code></li><li class="L5"><code class="language-json"><span class="pln"> </span><span class="pun">{</span></code></li><li class="L6"><code class="language-json"><span class="pln"> </span><span class="str">"province"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"广东省"</span><span class="pun">,</span></code></li><li class="L7"><code class="language-json"><span class="pln"> </span><span class="str">"city"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"深圳市"</span><span class="pun">,</span></code></li><li class="L8"><code class="language-json"><span class="pln"> </span><span class="str">"company"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"西安星巴克咖啡有限公司"</span><span class="pun">,</span></code></li><li class="L9"><code class="language-json"><span class="pln"> </span><span class="str">"id"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"50928"</span><span class="pun">,</span></code></li><li class="L0"><code class="language-json"><span class="pln"> </span><span class="str">"name"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"咸阳丽彩万达店"</span><span class="pun">,</span></code></li><li class="L1"><code class="language-json"><span class="pln"> </span><span class="str">"addr"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"咸阳市秦都区玉泉东路与泉北三巷交叉口西北角咸阳丽彩万达广场1楼"</span><span class="pun">,</span></code></li><li class="L2"><code class="language-json"><span class="pln"> </span><span class="str">"manager"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"Higer 司咸林"</span><span class="pun">,</span></code></li><li class="L3"><code class="language-json"><span class="pln"> </span><span class="str">"managerPhone"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"13279566588"</span><span class="pun">,</span></code></li><li class="L4"><code class="language-json"><span class="pln"> </span><span class="str">"email"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"S50928@starbucks.cn"</span><span class="pun">,</span></code></li><li class="L5"><code class="language-json"><span class="pln"> </span><span class="str">"phone"</span><span class="pun">:</span><span class="pln"> </span><span class="str">""</span><span class="pun">,</span></code></li><li class="L6"><code class="language-json"><span class="pln"> </span><span class="str">"posNum"</span><span class="pun">:</span><span class="pln"> </span><span class="lit">2</span><span class="pun">,</span></code></li><li class="L7"><code class="language-json"><span class="pln"> </span><span class="pun">},</span></code></li><li class="L8"><code class="language-json"><span class="pln"> </span><span class="pun">//</span><span class="pln"> </span><span class="pun">...</span></code></li><li class="L9"><code class="language-json"><span class="pln"> </span><span class="pun">]</span></code></li><li class="L0"><code class="language-json"><span class="pun">}</span></code></li></ol></pre><div class="md-section-divider"></div><h4 data-anchor-id="3pgw" id="响应示例-1">响应示例</h4><div class="md-section-divider"></div><pre class="prettyprint linenums prettyprinted" data-anchor-id="6nz7" style=""><ol class="linenums"><li class="L0"><code class="language-json"><span class="pun">{</span></code></li><li class="L1"><code class="language-json"><span class="pln"> </span><span class="str">"code"</span><span class="pun">:</span><span class="pln"> </span><span class="lit">100</span><span class="pun">,</span></code></li><li class="L2"><code class="language-json"><span class="pln"> </span><span class="str">"msg"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"成功"</span></code></li><li class="L3"><code class="language-json"><span class="pun">}</span></code></li></ol></pre><div class="md-section-divider"></div><h3 data-anchor-id="brge" id="返回码表">返回码表</h3><table data-anchor-id="v5ax" class="table table-striped-white table-bordered">
<thead>
<tr>
<th style="text-align:center;">返回码</th>
<th style="text-align:center;">返回描述</th>
</tr>
</thead>
<tbody><tr>
<td style="text-align:center;">100</td>
<td style="text-align:center;">成功</td>
</tr>
<tr>
<td style="text-align:center;">101</td>
<td style="text-align:center;">前端根据msg进行提示</td>
</tr>
</tbody></table></div>
</body>
</html>
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment