API渠道服务-接口文档

API渠道服务,提供除充值API以外的标准接口能力。


获取福禄商品编号

<p>[TOC]</p> <h5>业务背景</h5> <ul> <li>由于合作方没有配置福禄商品编号的业务逻辑,由福禄来管理双方商品编号映射关系,使用此接口来获取福禄商品编号</li> </ul> <h5>接口描述</h5> <ul> <li>本接口用于根据合作方商品编号获取福禄商品编号,<strong>业务报文参数无需AES加密</strong></li> </ul> <h5>接口地址</h5> <ul> <li><code>/api/Product/GetProductId</code></li> </ul> <h5>请求方式</h5> <ul> <li>POST</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;">app_key</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>开放平台分配给商户的app_key</td> </tr> <tr> <td style="text-align: left;">encrypt_data</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>明文的业务报文,<strong>无需AES加密</strong></td> </tr> </tbody> </table> <h5>业务报文参数</h5> <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>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">customer_product_id</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td style="text-align: left;">100</td> <td>外部商品编号</td> </tr> </tbody> </table> <h5>业务报文参数示例</h5> <pre><code> { &amp;quot;customer_product_id&amp;quot;: &amp;quot;AD000140&amp;quot; }</code></pre> <h5>公共请求参数示例</h5> <pre><code> { &amp;quot;app_key&amp;quot;: &amp;quot;i4esv1l+76l/7NQCL3QudG90Fq+YgVfFGJAWgT+7qO1Bm9o/adG/1iwO2qXsAXNB&amp;quot;, &amp;quot;encrypt_data&amp;quot;: &amp;quot;{\&amp;quot;customer_product_id\&amp;quot;:\&amp;quot;AD000140\&amp;quot;}&amp;quot; }</code></pre> <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;">code</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>返回码,详见底部《业务错误码》</td> </tr> <tr> <td style="text-align: left;">message</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>返回码描述,详见底部《业务错误码》</td> </tr> <tr> <td style="text-align: left;">result</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>响应结果,json字符串</td> </tr> </tbody> </table> <h5>响应结果参数</h5> <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>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">product_id</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td style="text-align: left;">10</td> <td>福禄商品编号</td> </tr> </tbody> </table> <h5>成功响应示例</h5> <pre><code> { &amp;quot;code&amp;quot;: 0, &amp;quot;message&amp;quot;: &amp;quot;获取成功&amp;quot;, &amp;quot;result&amp;quot;: &amp;quot;{\&amp;quot;product_id\&amp;quot;:\&amp;quot;10000587\&amp;quot;}&amp;quot; }</code></pre> <h5>异常响应示例</h5> <pre><code> { &amp;quot;code&amp;quot;: 4001, &amp;quot;message&amp;quot;: &amp;quot;外部商品编号未关联&amp;quot;, &amp;quot;result&amp;quot;: &amp;quot;&amp;quot; }</code></pre> <h5>业务错误码</h5> <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;">0</td> <td style="text-align: left;">接口调用成功</td> <td>接口调用成功,按正常流程处理</td> </tr> <tr> <td style="text-align: left;">1005</td> <td style="text-align: left;">必须传入app_key</td> <td>请检查请求参数app_key是否为空</td> </tr> <tr> <td style="text-align: left;">1006</td> <td style="text-align: left;">无效的app_key</td> <td>1、检查appkey是否复制错误;&lt;br&gt;2、沙箱环境与生产环境数据不互通;&lt;br&gt;3、沙箱环境只能使用沙箱数据;</td> </tr> <tr> <td style="text-align: left;">1020</td> <td style="text-align: left;">接口权限验证失败,请联系接口提供方</td> <td>请联系接口提供方</td> </tr> <tr> <td style="text-align: left;">1021</td> <td style="text-align: left;">Api渠道未启用</td> <td>请联系接口提供方启用Api渠道</td> </tr> <tr> <td style="text-align: left;">1023</td> <td style="text-align: left;">接口权限未配置</td> <td>请联系接口提供方配置接口权限</td> </tr> <tr> <td style="text-align: left;">1025</td> <td style="text-align: left;">业务参数:外部商品编号不能为空</td> <td>请检查加密前的业务报文中customer_product_id是否为空</td> </tr> <tr> <td style="text-align: left;">1026</td> <td style="text-align: left;">业务参数:外部商品编号长度不能超过100</td> <td>请检查加密前的业务报文中customer_product_id字段长度</td> </tr> <tr> <td style="text-align: left;">4001</td> <td style="text-align: left;">外部商品编号未关联</td> <td>请联系福禄运营</td> </tr> <tr> <td style="text-align: left;">5001</td> <td style="text-align: left;">系统异常</td> <td>提供请求报文,联系接口提供方排查</td> </tr> </tbody> </table>

页面列表

ITEM_HTML