serviceDoc.txt 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114
  1. **1\. 保存商户**
  2. ###### 接口功能
  3. > API服务做保存商户时调用该接口
  4. ###### URL
  5. > [http://store-service/storeApi/service](http://store-service/storeApi/service)
  6. ###### 支持格式
  7. > JSON
  8. ###### HTTP请求方式
  9. > POST
  10. ###### 协议接口
  11. |父元素名称|参数名称|约束|类型|长度|描述|取值说明|
  12. | :-: | :-: | :-: | :-: | :-: | :-: | :-:|
  13. |-|orders|1|Object|-|订单节点|-|
  14. |-|business|1|Array|-|业务节点|-|
  15. ###### orders
  16. |父元素名称|参数名称|约束|类型|长度|描述|取值说明|
  17. | :-: | :-: | :-: | :-: | :-: | :-: | :-: |
  18. |-|orders|1|Object|-|订单节点|-|
  19. |orders|appId|1|String|10|系统ID|由中心服务提供|
  20. |orders|transactionId|1|String|30|交互流水|appId+'00'+YYYYMMDD+10位序列|
  21. |orders|userId|1|String|30|用户ID|已有用户ID|
  22. |orders|orderTypeCd|1|String|4|订单类型|查看订单类型说明|
  23. |orders|requestTime|1|String|14|请求时间|YYYYMMDDhhmmss|
  24. |orders|remark|1|String|200|备注|备注|
  25. |orders|sign|?|String|64|签名|查看加密说明|
  26. |orders|attrs|?|Array|-|订单属性|-|
  27. |attrs|specCd|1|String|12|规格编码|由中心服务提供|
  28. |attrs|value|1|String|50|属性值|-|
  29. |orders|response|1|Object|-|返回结果节点|-|
  30. |response|code|1|String|4|返回状态|查看状态说明|
  31. |response|message|1|String|200|返回状态描述|-|
  32. ###### business
  33. |父元素名称|参数名称|约束|类型|长度|描述|取值说明|
  34. | :-: | :-: | :-: | :-: | :-: | :-: | :-: |
  35. |-|business|?|Array|-|业务节点|-|
  36. |business|businessTypeCd|1|String|12|业务类型编码|500100030002|
  37. |business|datas|1|Object|-|数据节点|不同的服务下的节点不一样|
  38. |datas|businessStoreInfo|1|Object|-|小区成员|小区成员|
  39. $busienssInfo$
  40. ###### 返回协议
  41. 当http返回状态不为200 时请求处理失败 body内容为失败的原因
  42. 当http返回状态为200时请求处理成功,body内容为返回内容,
  43. ###### 举例
  44. > 地址:[http://store-service/storeApi/service](http://store-service/storeApi/service)
  45. ``` javascript
  46. 请求头信息:
  47. Content-Type:application/json
  48. 请求报文:
  49. {
  50. "orders": {
  51. "appId": "外系统ID,分配得到",
  52. "transactionId": "100000000020180409224736000001",
  53. "userId": "用户ID",
  54. "orderTypeCd": "订单类型,查询,受理",
  55. "requestTime": "20180409224736",
  56. "remark": "备注",
  57. "sign": "这个服务是否要求MD5签名",
  58. "businessType":"I",
  59. "attrs": [{
  60. "specCd": "配置的字段ID",
  61. "value": "具体值"
  62. }]
  63. },
  64. "business": {
  65. "businessTypeCd": "$businessTypeCd$",
  66. "bId":"1234567892",
  67. "remark": "备注",
  68. "datas": {
  69. "businessStoreInfo": {
  70. $businessInfoJson$
  71. }
  72. },
  73. "attrs": [{
  74. "specCd": "配置的字段ID",
  75. "value": "具体值"
  76. }]
  77. }
  78. }
  79. 返回报文:
  80. {
  81. "orderTypeCd": "D",
  82. "response": {
  83. "code": "0000",
  84. "message": "成功"
  85. },
  86. "responseTime": "20190418102004",
  87. "bId": "202019041810750003",
  88. "businessType": "B",
  89. "transactionId": "3a5a411ec65a4c3f895935638aa1d2bc",
  90. "dataFlowId": "44fde86d39ce46f4b4aab5f6b14f3947"
  91. }
  92. ```