Commit 950457bbe1b17a7852970fb6aa2e20c7420cf4f1

Authored by 王富国
1 parent f3509029
Exists in master

feat: 添加一物一码接口

order/warehouse/YiWuYiMa/2022111001/一物一码接口.md 0 → 100644
... ... @@ -0,0 +1,246 @@
  1 +[toc]
  2 +
  3 +# 一物一码对接API
  4 +
  5 +则一提供了不同规范的API,调用服务端API前,需了解开发前须知及调用流程。本文提供了调用则一服务端API示例,供开发者参考。
  6 +
  7 +## 白名单
  8 +
  9 +则一服务端API接口访问有IP白名单限制,需要接口调用方提供调用API的服务器IP地址。
  10 +
  11 +## 数据加签
  12 +
  13 +采用md5(32位小写)算法生成签名
  14 +appKey(则一提供) + appSecret(则一提供) + timestamp(当前时间戳毫秒) + nonce(6位随机码大小写字母数子组合) + data(请求数据)
  15 +
  16 +## 数据加密
  17 +
  18 +数据加密采用AES算法
  19 +加密模式: CBC
  20 +填充方式:PKCS5Padding
  21 +偏移量:iv(则一提供)
  22 +加密内容:appKey(则一提供) + timestamp(当前时间戳毫秒) + nonce(6位随机码大小写字母数子组合) + data(加密数据)
  23 +密钥: appSecret(则一提供)
  24 +输出:base64
  25 +字符集:utf-8
  26 +注:无敏感数据则无需加密
  27 +
  28 +## 获取访问凭证
  29 +
  30 +### 概述
  31 +
  32 +调用则一服务API时,都需要先获取对应权限类型的访问凭证accessToken。访问凭证(accessToken)是由则一权限系统颁发的,用来校验调用者的身份信息,确保调用者具有要执行的操作的权限。
  33 +**说明**: 在使用accessToken时,请注意:
  34 +
  35 +* accessToken的有效期默认为30天,有效期内重复获取会返回相同结果,过期后获取会返回新的accessToken。
  36 +* 开发者需要缓存accessToken,用于后续接口的调用。不能频繁调用获取accessToken接口,否则会受到频率拦截。
  37 +* 当调用业务API时,如果返回状态码为401,则说明accessToken不正确或已过期,这时需要重新获取accessToken后再调用对应的API。
  38 +
  39 +### 接口信息
  40 +
  41 +#### 请求方式:
  42 +
  43 +post
  44 +
  45 +#### 请求地址:
  46 +
  47 +* 生产:https://gw.shjiuze.cn/auth-service-api/login/password
  48 +* 测试:https://test.shjiuze.cn/auth-service-api/login/password
  49 +
  50 +#### Body参数
  51 +
  52 +| 名称 | 类型 | 必填 | 示例值 | 描述 |
  53 +| -------- | ------ | ---- | ----------- | ---------------- |
  54 +| username | String | 是 | zhangsan | 用户名,则一提供 |
  55 +| password | String | 是 | password123 | 密码,则一提供 |
  56 +
  57 +#### 返回参数
  58 +
  59 +| 名称 | 类型 | 示例值 | 描述 |
  60 +| ------------------------------ | ---------- | -------------------------------- | -------------------------------------------------- |
  61 +| success | boolean | true | 成功标识: true 成功,false 失败 |
  62 +| businessException | boolean | false | 业务异常标识: true 业务异常,false 正常 |
  63 +| errorCode | String | 200 | 错误码: 200 业务异常,500 系统异常, 空表示无错误 |
  64 +| message | String | 订单号不能为空 | 错误信息,无错误则返回空 |
  65 +| result | ZYTokenDto | | accessToken结果数据 |
  66 +|     accessToken | String | 000626f15b4b41bba6fe56216a5d2f73 | accessToken |
  67 +|     expiresIn | Integer | 2060 | 有效期限单位秒,accessToken在2060秒后过期 |
  68 +|     tokenType | String | bearer | token类型 |
  69 +
  70 +#### 请求示例
  71 +
  72 +##### Http方式
  73 +
  74 +```http
  75 +POST /auth-service-api/login/password HTTP/1.1
  76 +Host:test.shjiuze.cn
  77 +Content-Type:application/json
  78 +
  79 +{
  80 + "username" : "zeyi",
  81 + "password" : "test1111"
  82 +}
  83 +```
  84 +
  85 +##### Java-sdk方式
  86 +
  87 +##### [下载SDK](https://zeyi-tms-product.oss-cn-hangzhou.aliyuncs.com/file/jar/java-sdk/zy-java-sdk-1.0.0.jar)
  88 +
  89 +```java
  90 +public class Sample {
  91 + public static void main(String[] args_) {
  92 + String appKey = "appkey";
  93 + String appSecret = "appSecret";
  94 + ZYClient zyClient = new ZYClient(appKey, appSecret);
  95 + ZYTokenRequestDto zyTokenRequest = new ZYTokenRequestDto();
  96 + zyTokenRequest.setUsername("zeyi");
  97 + zyTokenRequest.setPassword("test1111");
  98 + String body = gson.toJson(zyTokenRequest);
  99 + HttpResponseData httpResponseData = zyClient.doPost(Constants.TEST_HOST + Constants.TOKEN_PATH, body);
  100 + if(httpResponseData == null) {
  101 + throw new TokenException("则一Token请求失败,返回为空!");
  102 + }
  103 + ZYResponse<ZYTokenDto> zyResponse = gson.fromJson(httpResponseData.getBody(), new TypeToken<ZYResponse<ZYTokenDto>>(){}.getType());
  104 + if(!Boolean.TRUE.equals(zyResponse.isSuccess())) {
  105 + throw new TokenException("则一Token请求返回失败!" + zyResponse.getMessage());
  106 + }
  107 + if(zyResponse.getResult() == null) {
  108 + throw new TokenException("则一Token请求返回失败,返回结果为空!" + zyResponse.getMessage());
  109 + }
  110 + if(StringUtils.isBlank(zyResponse.getResult().getAccessToken())) {
  111 + throw new TokenException("则一Token请求返回数据异常,AccessToken为空!" + zyResponse.getMessage());
  112 + }
  113 + // 结果 zyResponse.getResult();
  114 + }
  115 +}
  116 +```
  117 +
  118 +#### 返回示例
  119 +
  120 +```json
  121 +{
  122 + "success": true,
  123 + "businessException": false,
  124 + "errorCode": null,
  125 + "message": null,
  126 + "result": {
  127 + "accessToken": "64d7f367-609b-4f7d-a84d-a3d2a0b5ad85",
  128 + "expiresIn": 602105,
  129 + "tokenType": "bearer"
  130 + }
  131 +}
  132 +```
  133 +
  134 +
  135 +
  136 +## 入库扫码
  137 +
  138 +### 简要描述
  139 +
  140 +入库扫码接口,接收WMS回传的扫码信息
  141 +
  142 +### 请求URL
  143 +
  144 +· 测试环境:https://test.shjiuze.cn/wms-service-api/warehouseOrder/inStockScanCode
  145 +
  146 +· 生产环境:https://gw.shjiuze.cn/wms-service-api/warehouseOrder/inStockScanCode
  147 +
  148 +### 请求方式
  149 +
  150 +POST
  151 +
  152 +### Headers参数
  153 +
  154 +| 名称 | 类型 | 必填 | 示例值 | 描述 |
  155 +| ------------- | ------ | -------------------------- | -------------------------------- | ------------------------------------------------------------ |
  156 +| Authorization | String | 是&nbsp;&nbsp;&nbsp;&nbsp; | Bearer a2c5680001 | 调用服务端API的应用凭证accessToken,通过调用获取访问凭证接口获取。 |
  157 +| appKey | String | 是 | 0867ef5f23ef446483749e19e1692b40 | 则一提供 |
  158 +| timestamp | String | 是 | 1643251533306 | 当前时间戳毫秒值 |
  159 +| nonce | String | 是 | gdst9t | 6位小写字母数字组合随机串 |
  160 +| sign | String | 是 | fa3ed338d6dfe18e7273c8692234ee70 | 签名:appKey(则一提供) + appSecret(则一提供) + timestamp + nonce(6位随机码) + data(body参数)通过md5(32位小写)算法生成 |
  161 +
  162 +### Body参数
  163 +
  164 +| 参数名 | 必传 | 类型 | 说明 |
  165 +| ------------------------------------ | ---- | ------ | -------------------------------------------- |
  166 +| code | 是 | string | 单据编号 |
  167 +| reportStatus | 是 | string | 上报状态(已上报(REPORTED)/未上报(UN_REPORT)) |
  168 +| opreationTime | 是 | string | 操作日期时间戳(毫秒)(如无默认当前时间) |
  169 +| factoryCode | 是 | string | 工厂代码 |
  170 +| warehouseCode | 是 | string | 仓库代码 |
  171 +| warehouseName | 是 | string | 仓库名称 |
  172 +| billReason | 否 | string | 单据原因 |
  173 +| remark | 否 | string | 备注 |
  174 +| codeList | 是 | list | 编码集合 |
  175 +| &nbsp;&nbsp;&nbsp;&nbsp;code | 是 | string | 明细编码 |
  176 +| &nbsp;&nbsp;&nbsp;&nbsp;reportStatus | 是 | string | 上报状态(已上报(REPORTED)/未上报(UN_REPORT)) |
  177 +| &nbsp;&nbsp;&nbsp;&nbsp;extend1 | 否 | string | 扩展字段1 |
  178 +| &nbsp;&nbsp;&nbsp;&nbsp;extend2 | 否 | string | 扩展字段2 |
  179 +| &nbsp;&nbsp;&nbsp;&nbsp;extend3 | 否 | string | 扩展字段3 |
  180 +| &nbsp;&nbsp;&nbsp;&nbsp;extend4 | 否 | string | 扩展字段4 |
  181 +| &nbsp;&nbsp;&nbsp;&nbsp;remark | 否 | string | 备注 |
  182 +| extendList | 否 | list | 扩展字段 |
  183 +| &nbsp;&nbsp;&nbsp;&nbsp;name | 是 | string | 属性名 |
  184 +| &nbsp;&nbsp;&nbsp;&nbsp;value | 是 | string | 属性值 |
  185 +
  186 +
  187 +
  188 +## 出库扫码
  189 +
  190 +### 简要描述
  191 +
  192 +出库扫码接口,接收WMS回传的扫码信息
  193 +
  194 +### 请求URL
  195 +
  196 +· 测试环境:https://test.shjiuze.cn/wms-service-api/warehouseOrder/outStockScanCode
  197 +
  198 +· 生产环境:https://gw.shjiuze.cn/wms-service-api/warehouseOrder/outStockScanCode
  199 +
  200 +### 请求方式
  201 +
  202 +POST
  203 +
  204 +### Headers参数
  205 +
  206 +| 名称 | 类型 | 必填 | 示例值 | 描述 |
  207 +| ------------- | ------ | -------------------------- | -------------------------------- | ------------------------------------------------------------ |
  208 +| Authorization | String | 是&nbsp;&nbsp;&nbsp;&nbsp; | Bearer a2c5680001 | 调用服务端API的应用凭证accessToken,通过调用获取访问凭证接口获取。 |
  209 +| appKey | String | 是 | 0867ef5f23ef446483749e19e1692b40 | 则一提供 |
  210 +| timestamp | String | 是 | 1643251533306 | 当前时间戳毫秒值 |
  211 +| nonce | String | 是 | gdst9t | 6位小写字母数字组合随机串 |
  212 +| sign | String | 是 | fa3ed338d6dfe18e7273c8692234ee70 | 签名:appKey(则一提供) + appSecret(则一提供) + timestamp + nonce(6位随机码) + data(body参数)通过md5(32位小写)算法生成 |
  213 +
  214 +### Body参数
  215 +
  216 +| 参数名 | 必传 | 类型 | 说明 |
  217 +| ------------------------------------ | ---- | ------ | -------------------------------------------- |
  218 +| code | 是 | string | 单据编号 |
  219 +| reportStatus | 是 | string | 上报状态(已上报(REPORTED)/未上报(UN_REPORT)) |
  220 +| opreationTime | 是 | string | 操作日期时间戳(毫秒)(如无默认当前时间) |
  221 +| warehouseCode | 是 | string | 仓库代码 |
  222 +| warehouseName | 是 | string | 仓库名称 |
  223 +| customerCode | 否 | string | 客户编码 |
  224 +| customerName | 是 | string | 客户名称 |
  225 +| billReason | 否 | string | 单据原因 |
  226 +| remark | 否 | string | 备注 |
  227 +| codeList | 是 | list | 编码集合 |
  228 +| &nbsp;&nbsp;&nbsp;&nbsp;code | 是 | string | 明细编码 |
  229 +| &nbsp;&nbsp;&nbsp;&nbsp;reportStatus | 是 | string | 上报状态(已上报(REPORTED)/未上报(UN_REPORT)) |
  230 +| &nbsp;&nbsp;&nbsp;&nbsp;extend1 | 否 | string | 扩展字段1 |
  231 +| &nbsp;&nbsp;&nbsp;&nbsp;extend2 | 否 | string | 扩展字段2 |
  232 +| &nbsp;&nbsp;&nbsp;&nbsp;extend3 | 否 | string | 扩展字段3 |
  233 +| &nbsp;&nbsp;&nbsp;&nbsp;extend4 | 否 | string | 扩展字段4 |
  234 +| &nbsp;&nbsp;&nbsp;&nbsp;remark | 否 | string | 备注 |
  235 +| extendList | 否 | list | 扩展字段 |
  236 +| &nbsp;&nbsp;&nbsp;&nbsp;name | 是 | string | 属性名 |
  237 +| &nbsp;&nbsp;&nbsp;&nbsp;value | 是 | string | 属性值 |
  238 +
  239 +
  240 +
  241 +------------------------------------------------------------------------------------------
  242 +
  243 +## 2022-11-10 更新日志
  244 +
  245 +1. 接口初始化
  246 +
... ...