Pārlūkot izejas kodu

添加保存商户协议

吴学文 7 gadi atpakaļ
vecāks
revīzija
6ec2f98113
3 mainītis faili ar 116 papildinājumiem un 156 dzēšanām
  1. 19 18
      docs/_sidebar.md
  2. 97 0
      docs/api/store/saveStore.md
  3. 0 138
      docs/api/user/Readme.md

+ 19 - 18
docs/_sidebar.md

@@ -4,27 +4,28 @@
   * [快速开始](home.md)
   * [安装部署](install.md)
 
-* 服务端接口协议
+* api接口
 
-  * [字典规格说明](dictionary)
-  * [中心服务接口协议](center)
-  * [中心服务配置文档](center_config)
-  * [用户服务接口协议](user)
-  * [用户服务接口测试文档](user_test)
-  * [商品服务接口协议](shop)
-  * [商品服务接口测试文档](shop_test)
-  * [商户服务接口协议](store)
-  * [商户服务接口测试文档](store_test)
-  * [评论服务接口协议](comment)
-  * [评论服务接口测试文档](comment_test)
-  * [编码生成服务接口协议](code)
-  * [编码生成服务接口测试文档](code_test)
+  * [用户注册](api/user/register.md)
+  * [用户登录](api/user/login.md)
+  * [用户校验登录](api/user/checkLogin.md)
+  * [保存商户](api/user/saveStore.md)
 
-* api接口
+* 服务端接口协议
 
-  * [用户注册](api/user/register)
-  * [用户登录](api/user/login)
-  * [用户校验登录](api/user/checkLogin)
+  * [字典规格说明](dictionary)
+  * [中心服务接口协议](services/order/order.md)
+  * [中心服务配置文档](services/order/order_config.md)
+  * [用户服务接口协议](services/user/user.md)
+  * [用户服务接口测试文档](services/user/user_test.md)
+  * [商品服务接口协议](services/shop/shop.md)
+  * [商品服务接口测试文档](services/shop/shop_test.md)
+  * [商户服务接口协议](services/store/store.md)
+  * [商户服务接口测试文档](services/store/store_test.md)
+  * [评论服务接口协议](services/comment/comment.md)
+  * [评论服务接口测试文档](services/comment/comment_test.md)
+  * [编码生成服务接口协议](services/code/code)
+  * [编码生成服务接口测试文档](services/code/code_test)
 
 * 工具类接口
 

+ 97 - 0
docs/api/store/saveStore.md

@@ -0,0 +1,97 @@
+
+
+**1\. 保存商户**
+###### 接口功能
+> 用户通过web端或APP完善商户信息接口
+
+###### URL
+> [http://api.java110.com:8008/api/save.store.info](http://api.java110.com:8008/api/save.store.info)
+
+###### 支持格式
+> JSON
+
+###### HTTP请求方式
+> POST
+
+###### 请求参数(header部分)
+|参数名称|约束|类型|长度|描述|取值说明|
+| :-: | :-: | :-: | :-: | :-: | :-:|
+|app_id|1|String|30|应用ID|Api服务分配                      |
+|transaction_id|1|String|30|请求流水号|不能重复 1000000000+YYYYMMDDhhmmss+6位序列 |
+|sign|1|String|-|签名|请参考签名说明|
+|req_time|1|String|-|请求时间|YYYYMMDDhhmmss|
+
+###### 请求参数(body部分)
+|父参数名称|参数名称|约束|类型|长度|描述|取值说明|
+| :-: | :-: | :-: | :-: | :-: | :-: | :-: |
+|-|businessStore|object|-|-|商户基本节点|-|
+|businessStore|userId|String|-|30|用户ID|-|
+|businessStore|name|1|String|50|商户名称|-|
+|businessStore|address|1|String|200|商户地址|-|
+|businessStore|password|?|String|200|密码|MD5加密密码|
+|businessStore|tel|1|String|11|联系电话|-|
+|businessStore|storeTypeCd|1|String|10|店铺种类|详见表store_type定义|
+|businessStore|nearbyLandmarks|1|String|200|地标|地标,如王府井北60米|
+|businessStore|mapX|1|String|20|地区 x坐标|-|
+|businessStore|mapY|1|String|20|地区 y坐标|-|
+|-|businessStoreAttr|?|object|-|商户属性|-|
+|businessStoreAttr|specCd|1|String|12|属性编码|商户服务提供|
+|businessStoreAttr|value|1|String|50|属性值|-|
+|-|businessStoreCerdentials|?|object|-|商户证件|-|
+|businessStoreCerdentials|credentialsCd|1|String|12|证件类型|对应于 credentials表|
+|businessStoreCerdentials|value|1|String|50|证件号码|-|
+|businessStoreCerdentials|validityPeriod|1|String|-|有效期|格式为YYYY-MM-DD hh:mm:ss 例如:2018-07-07 11:04:00 如果是长期有效 写成 3000-01-01 00:00:00|
+|businessStoreCerdentials|positivePhoto|1|String|100|正面照片|照片存储大数据中路径|
+|businessStoreCerdentials|negativePhoto|1|String|100|反面照片|照片存储大数据中路径|
+
+###### 返回协议
+
+当http返回状态不为200 时请求处理失败 body内容为失败的原因
+
+当http返回状态为200时请求处理成功,body内容为返回内容,
+
+
+
+
+###### 举例
+> 地址:[http://api.java110.com:8008/api/save.store.info](http://api.java110.com:8008/api/save.store.info)
+
+``` json
+请求头信息:
+Content-Type:application/json
+USER_ID:1234
+APP_ID:8000418004
+TRANSACTION_ID:10029082726
+REQ_TIME:20181113225612
+SIGN:aabdncdhdbd878sbdudn898
+请求报文:
+{
+      "businessStore": {
+        "userId": "30518940136629616640",
+        "name": "齐天超时(王府井店)",
+        "address": "青海省西宁市城中区129号",
+        "password": "ERCBHDUYFJDNDHDJDNDJDHDUDHDJDDKDK",
+        "tel": "15897089471",
+        "storeTypeCd": "M",
+        "nearbyLandmarks": "王府井内",
+        "mapX": "101.801909",
+        "mapY": "36.597263"
+      },
+      "businessStoreAttr": [{
+        "specCd":"1001",
+        "value":"01"
+      }],
+      "businessStoreCerdentials":[{
+        "credentialsCd":"300200900001",
+        "value":"632126XXXXXXXX2011",
+        "validityPeriod":"3000-01-01",
+        "positivePhoto":"1234567.jpg",
+        "negativePhoto":""
+      }]
+
+}
+返回报文:
+状态码为 200
+成功
+
+```

+ 0 - 138
docs/api/user/Readme.md

@@ -1,138 +0,0 @@
-### 用户注册
-
-#### 请求地址
-http://localhost:8008/api/user.service.register
-
-#### 请求方式
-POST
-
-#### 请求协议(header部分)
-参数名称|约束|类型|长度|描述|取值说明
- :-: | :-: | :-: | :-: | :-: | :-:
-app_id|1|String|30|应用ID|Api服务分配
-transaction_id|1|String|30|请求流水号|不能重复 1000000000+YYYYMMDDhhmmss+6位序列
-sign|1|String|-|签名|请参考签名说明
-req_time|1|String|-|请求时间|YYYYMMDDhhmmss
-
-#### 请求协议(body部分)
-参数名称|约束|类型|长度|描述|取值说明
- :-: | :-: | :-: | :-: | :-: | :-:
-name|1|String|50|用户名称|-
-email|1|String|30|邮箱地址|邮箱地址1234@xx.com
-password|1|String|128|密码|加盐码md5
-tel|1|String|11|手机号|11位手机号
-sex|?|String|1|性别|0表示男孩 1表示女孩
-
-#### 返回协议
-当http返回状态不为200 时请求处理失败 body内容为失败的原因
-
-当http返回状态为200时请求处理成功,body内容为返回内容,协议如下:
-
-参数名称|约束|类型|长度|描述|取值说明
- :-: | :-: | :-: | :-: | :-: | :-:
-userId|1|String|30|用户名称|用户ID
-responseTime|?|String|16|时间|请求返回的时间
-
-#### 举例
-
-请求报文:
-```
-{
-     "name": "张三",
-     "email": "928255095@qq.com",
-     "password": "ERCBHDUYFJDNDHDJDNDJDHDUDHDJDDKDK",
-     "sex": "0",
-     "tel": "17797173943"
-}
-```
-
-返回报文:
-
-```
-{"responseTime":"20181125230634","userId":"30516389265349820416"}
-```
-
-
-### 用户登录
-
-#### 请求地址
-http://api.java110.com:8008/api/user.service.login
-
-#### 请求方式
-POST
-
-#### 请求协议(header部分)
-请参考用户注册的头信息
-
-#### 请求协议(body部分)
-参数名称|约束|类型|长度|描述|取值说明
- :-: | :-: | :-: | :-: | :-: | :-:
-username|1|String|50|用户名|-
-passwd|1|String|30|密码|-
-
-#### 返回协议
-当http返回状态不为200 时请求处理失败 body内容为失败的原因
-
-当http返回状态为200时请求处理成功,body内容为返回内容,协议如下:
-
-参数名称|约束|类型|长度|描述|取值说明
- :-: | :-: | :-: | :-: | :-: | :-:
-userName|1|String|30|用户名称|用户名称
-userId|1|String|30|用户ID|用户ID
-token|?|String|64|鉴权码|鉴权码
-
-#### 举例
-
-请求报文:
-```
-{
-	"username":"admin",
-	"passwd":"d57167e07915c9428b1c3aae57003807"
-}
-```
-
-返回报文:
-
-```
-{"userName":"admin","userId":"10001","token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJqYXZhMTEwIiwianRpIjoiNmUzZGNjMzM3YmE4NGRmMTgxNzcwNDVjOTIzOTljOTAifQ.oUotKsoy1TXBS37isSvwKTQ9c_tTxZS48TA554QdbEU"}
-```
-
-### 校验登录
-
-#### 请求地址
-http://api.java110.com:8008/api/check.service.login
-
-#### 请求方式
-POST
-
-#### 请求协议(header部分)
-请参考用户注册的头信息
-
-#### 请求协议(body部分)
-参数名称|约束|类型|长度|描述|取值说明
- :-: | :-: | :-: | :-: | :-: | :-:
-token|1|String|50|鉴权码|-
-
-#### 返回协议
-当http返回状态不为200 时请求处理失败 body内容为失败的原因
-
-当http返回状态为200时请求处理成功,body内容为返回内容,协议如下:
-
-参数名称|约束|类型|长度|描述|取值说明
- :-: | :-: | :-: | :-: | :-: | :-:
-userId|1|String|30|用户ID|用户ID
-
-#### 举例
-
-请求报文:
-```
-{
-	"token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJqYXZhMTEwIiwianRpIjoiOGU1ZGY4NjBhYTUyNDgyNzk3MjBjZDFjNzg3ZDk4OTkifQ.PGwR_YjIDwn8sQFKr7CDmUk87MYt1lgi1s7a5OrE_Jg"
-}
-```
-
-返回报文:
-
-```
-{"userId":"10001"}
-```