拜哥网API文档

====== 促销系统API文档 ======

===== 接口说明 =====
本文档是拜哥网促销系统接口。

===== 安全签名方式 =====
=== 1、MD5安全签名机制 ===
MD5安全签名机制是商户和商城系统约定一个签名key，每次在做签名时将key=value附在待签名字符串后面，然后经MD5加密运算后得到一个签名串，商户和商城系统在检验时也采用同样的方式得到签名串，经比对后确定是否一致，如果一致，则签名通过。目前采用MD5签名

=== 2、需要参与签名的参数 ===
直接把请求数据中的所有元素(除sign和signType)按照“key值=value值”的格式拼接起来，并且把这些拼接以后的元素以“&”字符再连接起来（顺序按首字母升序排列，值为空的不参与签名），如： 
access-token=test01&name=test2&sign_type=MD5
这段字符串即是您支付请求时的待签名字符串。 
如果为MD5加密的则如下：(参数按顺序按首字母升序排列，值为空的不参与签名，MD5的key值放在最后，其他待签名字符串同理可得)

===== 接口规范  =====

报文格式：工分系统响应报文格式有JSON和XML格式，默认为JSON数据格式

报文请求：GET 和 POST

接口请求地址：<wrap em>接口基本URL + 接口名称</wrap>

===== 测试参数 =====

^ 参数              ^ 值                               ^
| userToken       | users                           |
| MD5 签名KEY       | test88                          |
| 数字签名方式signType  | MD5  （<wrap em>不参与数字签名</wrap>）  |
| 接口基本URL         | http://api.shop.my.com/v1/      |

===== 接口公共参数 =====

公共参数指的是在调用API接口时都必须要提供的参数,请求参数不分先后顺序。

^ 参数名称       ^ 参数类型    ^ 是否必填  ^ 说明                    ^
| userToken  | string  | 是     | API用户Token            |
| timestamp  | string  | 是     | 时间戳 格式YYYYMMDDHHIISS  |
| signType   | string  | 是     | 签名类型，目前只支持MD5         |
| sign       | string  | 是     | 签名                    |

===== 枚举类型 =====
==== _meta参数 ====

^ 参数名称       ^ 参数类型  ^ 说明                    ^
| totalCount| int| 记录总数            |
| pageCount| int| 页数  |
| currentPage| int| 当前页        |
| perPage| int| 每页显示数量                   |

==== _links参数 ====
拜哥网API文档

用户工具

站点工具

页面工具
