Commit 2f592d4770d31f23b060cbbae797cde8768f524f
1 parent
7b6f5519
Exists in
master
feat: 添加订单接口文档
Showing
1 changed file
with
368 additions
and
0 deletions
Show diff stats
| @@ -0,0 +1,368 @@ | @@ -0,0 +1,368 @@ | ||
| 1 | + | ||
| 2 | + | ||
| 3 | +[toc] | ||
| 4 | + | ||
| 5 | +### 则一订单对接API | ||
| 6 | + | ||
| 7 | +则一提供了不同规范的API，调用则一订单服务端API前，需了解开发前须知及调用流程。本文提供了调用则一订单服务端API示例，供开发者参考。 | ||
| 8 | + | ||
| 9 | +#### 白名单 | ||
| 10 | + | ||
| 11 | +则一服务端API接口访问有IP白名单限制，需要接口调用方提供调用API的服务器IP地址。 | ||
| 12 | + | ||
| 13 | +#### 数据加签 | ||
| 14 | + | ||
| 15 | +采用md5(32位小写)算法生成签名 | ||
| 16 | +appKey(则一提供) + appSecret(则一提供) + timestamp(当前时间戳毫秒) + nonce(6位随机码大小写字母数子组合) + data(请求数据) | ||
| 17 | + | ||
| 18 | +#### 数据加密 | ||
| 19 | + | ||
| 20 | +数据加密采用AES算法 | ||
| 21 | +加密模式： CBC | ||
| 22 | +填充方式：PKCS5Padding | ||
| 23 | +偏移量：iv(则一提供) | ||
| 24 | +加密内容：appKey(则一提供) + timestamp(当前时间戳毫秒) + nonce(6位随机码大小写字母数子组合) + data(加密数据) | ||
| 25 | +密钥： appSecret(则一提供) | ||
| 26 | +输出：base64 | ||
| 27 | +字符集：utf-8 | ||
| 28 | +注：无敏感数据则无需加密 | ||
| 29 | + | ||
| 30 | +#### 获取访问凭证 | ||
| 31 | + | ||
| 32 | +##### 概述 | ||
| 33 | + | ||
| 34 | +调用则一服务API时，都需要先获取对应权限类型的访问凭证accessToken。访问凭证（accessToken）是由则一权限系统颁发的，用来校验调用者的身份信息，确保调用者具有要执行的操作的权限。 | ||
| 35 | +**说明**： 在使用accessToken时，请注意： | ||
| 36 | + | ||
| 37 | +* accessToken的有效期默认为30天，有效期内重复获取会返回相同结果，过期后获取会返回新的accessToken。 | ||
| 38 | +* 开发者需要缓存accessToken，用于后续接口的调用。不能频繁调用获取accessToken接口，否则会受到频率拦截。 | ||
| 39 | +* 当调用业务API时，如果返回状态码为401，则说明accessToken不正确或已过期，这时需要重新获取accessToken后再调用对应的API。 | ||
| 40 | + | ||
| 41 | +##### 接口信息 | ||
| 42 | + | ||
| 43 | +###### 请求方式： | ||
| 44 | + | ||
| 45 | +post | ||
| 46 | + | ||
| 47 | +###### 请求地址： | ||
| 48 | + | ||
| 49 | +* 生产：https://gw.shjiuze.cn/auth-service-api/login/password | ||
| 50 | +* 测试：https://test.shjiuze.cn/auth-service-api/login/password | ||
| 51 | + | ||
| 52 | +###### Body参数 | ||
| 53 | + | ||
| 54 | +| 名称 | 类型 | 必填 | 示例值 | 描述 | | ||
| 55 | +| -------- | ------ | ---- | ----------- | ---------------- | | ||
| 56 | +| username | String | 是 | zhangsan | 用户名，则一提供 | | ||
| 57 | +| password | String | 是 | password123 | 密码，则一提供 | | ||
| 58 | + | ||
| 59 | +###### 返回参数 | ||
| 60 | + | ||
| 61 | +| 名称 | 类型 | 示例值 | 描述 | | ||
| 62 | +| ------------------------------ | ---------- | -------------------------------- | -------------------------------------------------- | | ||
| 63 | +| success | boolean | true | 成功标识: true 成功，false 失败 | | ||
| 64 | +| businessException | boolean | false | 业务异常标识: true 业务异常，false 正常 | | ||
| 65 | +| errorCode | String | 200 | 错误码: 200 业务异常，500 系统异常， 空表示无错误 | | ||
| 66 | +| message | String | 订单号不能为空 | 错误信息，无错误则返回空 | | ||
| 67 | +| result | ZYTokenDto | | accessToken结果数据 | | ||
| 68 | +| accessToken | String | 000626f15b4b41bba6fe56216a5d2f73 | accessToken | | ||
| 69 | +| expiresIn | Integer | 2060 | 有效期限单位秒，accessToken在2060秒后过期 | | ||
| 70 | +| tokenType | String | bearer | token类型 | | ||
| 71 | + | ||
| 72 | +##### 请求示例 | ||
| 73 | + | ||
| 74 | +###### Http方式 | ||
| 75 | + | ||
| 76 | +```http | ||
| 77 | +POST /auth-service-api/login/password HTTP/1.1 | ||
| 78 | +Host:test.shjiuze.cn | ||
| 79 | +Content-Type:application/json | ||
| 80 | + | ||
| 81 | +{ | ||
| 82 | + "username" : "zeyi", | ||
| 83 | + "password" : "test1111" | ||
| 84 | +} | ||
| 85 | +``` | ||
| 86 | + | ||
| 87 | +###### Java-sdk方式 [下载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 | +###### 请求方式： | ||
| 141 | + | ||
| 142 | +post | ||
| 143 | + | ||
| 144 | +###### 请求地址： | ||
| 145 | + | ||
| 146 | +* 生产：https://gw.shjiuze.cn/oms-service-api/jgwl/inquiryNotice | ||
| 147 | +* 测试：https://test.shjiuze.cn/oms-service-api/jgwl/inquiryNotice | ||
| 148 | + | ||
| 149 | +###### Headers参数 | ||
| 150 | + | ||
| 151 | +| 名称 | 类型 | 必填 | 示例值 | 描述 | | ||
| 152 | +| ------------- | ------ | ---- | -------------------------------- | ------------------------------------------------------------ | | ||
| 153 | +| Authorization | String | 是 | Bearer a2c5680001 | 调用服务端API的应用凭证accessToken，通过调用获取访问凭证接口获取。 | | ||
| 154 | +| appKey | String | 是 | 0867ef5f23ef6483749e19e1692b | 则一提供 | | ||
| 155 | +| timestamp | String | 是 | 1643251533306 | 当前时间戳毫秒值 | | ||
| 156 | +| nonce | String | 是 | gdst9t | 6位小写字母数字组合随机串 | | ||
| 157 | +| sign | String | 是 | fa3ed338d6dfe18e7273c8692234ee70 | 签名：appKey(则一提供) + appSecret(则一提供) + timestamp + nonce(6位随机码) + data(body参数)通过md5(32位小写)算法生成 | | ||
| 158 | + | ||
| 159 | +###### Body参数 | ||
| 160 | + | ||
| 161 | +| 名称 | 类型 | 必填 | 示例值 | 描述 | | ||
| 162 | +| ------------- | ------- | ---- | ------------- | ---------------------- | | ||
| 163 | +| id | String | 是 | 1112122324252 | 流水号 | | ||
| 164 | +| inquiryCode | String | 是 | 220101000001 | 询价单号 | | ||
| 165 | +| type | Integer | 是 | 100 | 类型 | | ||
| 166 | +| operationTime | Number | 否 | 1643251533306 | 操作时间，时间戳毫秒值 | | ||
| 167 | + | ||
| 168 | +##### 请求示例 | ||
| 169 | + | ||
| 170 | +###### Java-sdk方式 [下载SDK](https://zeyi-tms-product.oss-cn-hangzhou.aliyuncs.com/file/jar/java-sdk/zy-java-sdk-1.0.0.jar) | ||
| 171 | + | ||
| 172 | +```java | ||
| 173 | +public class Sample { | ||
| 174 | + public static void main(String[] args_) { | ||
| 175 | + String appKey = "appkey"; | ||
| 176 | + String appSecret = "appSecret"; | ||
| 177 | + String jsonData = "询价通知Body参数JSON数据"; | ||
| 178 | + ZYClient zyClient = new ZYClient(appKey, appSecret); | ||
| 179 | + HttpResponseData httpResponseData = | ||
| 180 | +zyClient.doPost(Constants.TEST_HOST + "/oms-service-api/jgwl/inquiryNotice", "accessToken", jsonData); | ||
| 181 | + if(httpResponseData == null) { | ||
| 182 | + throw new BusinessException("则一请求失败,返回结果为空!"); | ||
| 183 | + } | ||
| 184 | + if(httpResponseData.getStatus() == HttpURLConnection.HTTP_UNAUTHORIZED) { | ||
| 185 | + //重新获取token再次请求 | ||
| 186 | + httpResponseData = zyClient.doPost(Constants.TEST_HOST + | ||
| 187 | + "/oms-service-api/jgwl/inquiryNotice", "accessToken", jsonData); | ||
| 188 | + } | ||
| 189 | + } | ||
| 190 | +} | ||
| 191 | +``` | ||
| 192 | + | ||
| 193 | +##### 返回示例 | ||
| 194 | + | ||
| 195 | +```json | ||
| 196 | +{ | ||
| 197 | + "success": true, | ||
| 198 | + "businessException": false, | ||
| 199 | + "errorCode": null, | ||
| 200 | + "message": null, | ||
| 201 | + "result": { | ||
| 202 | + "id": "流水号", | ||
| 203 | + "inquiryCode": "询价单号", | ||
| 204 | + "type": 100 | ||
| 205 | + } | ||
| 206 | +} | ||
| 207 | +``` | ||
| 208 | + | ||
| 209 | + | ||
| 210 | + | ||
| 211 | +#### 运费确认接口 | ||
| 212 | + | ||
| 213 | +##### 接口信息 | ||
| 214 | + | ||
| 215 | +###### 概述 | ||
| 216 | + | ||
| 217 | +调用该接口确认运费信息。 | ||
| 218 | + | ||
| 219 | +###### 请求方式： | ||
| 220 | + | ||
| 221 | +post | ||
| 222 | + | ||
| 223 | +###### 请求地址： | ||
| 224 | + | ||
| 225 | +* 生产：https://gw.shjiuze.cn/oms-service-api/jgwl/confirmFreight | ||
| 226 | +* 测试：https://test.shjiuze.cn/oms-service-api/jgwl/confirmFreight | ||
| 227 | + | ||
| 228 | +###### Headers参数 | ||
| 229 | + | ||
| 230 | +| 名称 | 类型 | 必填 | 示例值 | 描述 | | ||
| 231 | +| ------------- | ------ | ---- | -------------------------------- | ------------------------------------------------------------ | | ||
| 232 | +| Authorization | String | 是 | Bearer a2c5680001 | 调用服务端API的应用凭证accessToken，通过调用获取访问凭证接口获取。 | | ||
| 233 | +| appKey | String | 是 | 0867ef5f23ef6483749e19e1692b | 则一提供 | | ||
| 234 | +| timestamp | String | 是 | 1643251533306 | 当前时间戳毫秒值 | | ||
| 235 | +| nonce | String | 是 | gdst9t | 6位小写字母数字组合随机串 | | ||
| 236 | +| sign | String | 是 | fa3ed338d6dfe18e7273c8692234ee70 | 签名：appKey(则一提供) + appSecret(则一提供) + timestamp + nonce(6位随机码) + data(body参数)通过md5(32位小写)算法生成 | | ||
| 237 | + | ||
| 238 | +###### Body参数 | ||
| 239 | + | ||
| 240 | +| 名称 | 类型 | 必填 | 示例值 | 描述 | | ||
| 241 | +| ------------- | ------- | ---- | ------------- | -------- | | ||
| 242 | +| inquiryCode | String | 是 | 220101000001 | 询价单号 | | ||
| 243 | +| type | Integer | 是 | 1 | 类型 | | ||
| 244 | +| operationTime | Number | 是 | 1643251533306 | 操作时间 | | ||
| 245 | + | ||
| 246 | +##### 请求示例 | ||
| 247 | + | ||
| 248 | +###### Java-sdk方式 [下载SDK](https://zeyi-tms-product.oss-cn-hangzhou.aliyuncs.com/file/jar/java-sdk/zy-java-sdk-1.0.0.jar) | ||
| 249 | + | ||
| 250 | +```java | ||
| 251 | +public class Sample { | ||
| 252 | + public static void main(String[] args_) { | ||
| 253 | + String appKey = "appkey"; | ||
| 254 | + String appSecret = "appSecret"; | ||
| 255 | + String jsonData = "确认运费Body参数JSON数据"; | ||
| 256 | + ZYClient zyClient = new ZYClient(appKey, appSecret); | ||
| 257 | + HttpResponseData httpResponseData = | ||
| 258 | +zyClient.doPost(Constants.TEST_HOST + "/oms-service-api/jgwl/confirmFreight", "accessToken", jsonData); | ||
| 259 | + if(httpResponseData == null) { | ||
| 260 | + throw new BusinessException("则一请求失败,返回结果为空!"); | ||
| 261 | + } | ||
| 262 | + if(httpResponseData.getStatus() == HttpURLConnection.HTTP_UNAUTHORIZED) { | ||
| 263 | + //重新获取token再次请求 | ||
| 264 | + httpResponseData = zyClient.doPost(Constants.TEST_HOST + | ||
| 265 | + "/oms-service-api/jgwl/confirmFreight", "accessToken", jsonData); | ||
| 266 | + } | ||
| 267 | + } | ||
| 268 | +} | ||
| 269 | +``` | ||
| 270 | + | ||
| 271 | + | ||
| 272 | + | ||
| 273 | +##### 返回示例 | ||
| 274 | + | ||
| 275 | +```json | ||
| 276 | +{ | ||
| 277 | + "success": true, | ||
| 278 | + "businessException": false, | ||
| 279 | + "errorCode": null, | ||
| 280 | + "message": null, | ||
| 281 | + "result": { | ||
| 282 | + "inquiryCode": "询价单号", | ||
| 283 | + "type": "类型" | ||
| 284 | + } | ||
| 285 | +} | ||
| 286 | +``` | ||
| 287 | + | ||
| 288 | + | ||
| 289 | + | ||
| 290 | +#### 推送发车/到车信息 | ||
| 291 | + | ||
| 292 | +##### 接口信息 | ||
| 293 | + | ||
| 294 | +###### 概述 | ||
| 295 | + | ||
| 296 | +调用该接口推送发车运输以及到达数据。 | ||
| 297 | + | ||
| 298 | +###### 请求方式： | ||
| 299 | + | ||
| 300 | +post | ||
| 301 | + | ||
| 302 | +###### 请求地址： | ||
| 303 | + | ||
| 304 | +* 生产：https://gw.shjiuze.cn/oms-service-api/jgwl/operationRecord | ||
| 305 | +* 测试：https://test.shjiuze.cn/oms-service-api/jgwl/operationRecord | ||
| 306 | + | ||
| 307 | +###### Body参数 | ||
| 308 | + | ||
| 309 | +| 名称 | 类型 | 必填 | 示例值 | 描述 | | ||
| 310 | +| ------------- | ------- | -------------- | ------------- | ---------- | | ||
| 311 | +| inquiryCode | String | 是 | 220101000001 | 询价单号 | | ||
| 312 | +| waybillCode | String | 是 | Y220101000001 | 运单号 | | ||
| 313 | +| type | Integer | 是 | 1 | 类型 | | ||
| 314 | +| departTime | Number | 是 | 1643251533306 | 发车时间戳 | | ||
| 315 | +| arrivalTime | Number | 是 | 1643251533306 | 到车时间戳 | | ||
| 316 | +| operationTime | Number | 是 | 1643251533306 | 操作时间戳 | | ||
| 317 | + | ||
| 318 | +##### 请求示例 | ||
| 319 | + | ||
| 320 | +###### Java-sdk方式 [下载SDK](https://zeyi-tms-product.oss-cn-hangzhou.aliyuncs.com/file/jar/java-sdk/zy-java-sdk-1.0.0.jar) | ||
| 321 | + | ||
| 322 | +```java | ||
| 323 | +public class Sample { | ||
| 324 | + public static void main(String[] args_) { | ||
| 325 | + String appKey = "appkey"; | ||
| 326 | + String appSecret = "appSecret"; | ||
| 327 | + String jsonData = "发车/到车Body参数JSON数据"; | ||
| 328 | + ZYClient zyClient = new ZYClient(appKey, appSecret); | ||
| 329 | + HttpResponseData httpResponseData = | ||
| 330 | +zyClient.doPost(Constants.TEST_HOST + "/oms-service-api/jgwl/operationRecord", "accessToken", jsonData); | ||
| 331 | + if(httpResponseData == null) { | ||
| 332 | + throw new BusinessException("则一请求失败,返回结果为空!"); | ||
| 333 | + } | ||
| 334 | + if(httpResponseData.getStatus() == HttpURLConnection.HTTP_UNAUTHORIZED) { | ||
| 335 | + //重新获取token再次请求 | ||
| 336 | + httpResponseData = zyClient.doPost(Constants.TEST_HOST + | ||
| 337 | + "/oms-service-api/jgwl/operationRecord", "accessToken", jsonData); | ||
| 338 | + } | ||
| 339 | + } | ||
| 340 | +} | ||
| 341 | +``` | ||
| 342 | + | ||
| 343 | +###### 返回示例 | ||
| 344 | + | ||
| 345 | +```json | ||
| 346 | +{ | ||
| 347 | + "success": true, | ||
| 348 | + "businessException": false, | ||
| 349 | + "errorCode": null, | ||
| 350 | + "message": null, | ||
| 351 | + "result": { | ||
| 352 | + "inquiryCode": "询价单号", | ||
| 353 | + "waybillCode": "运单号" | ||
| 354 | + } | ||
| 355 | +} | ||
| 356 | +``` | ||
| 357 | + | ||
| 358 | + | ||
| 359 | + | ||
| 360 | +### Java-sdk下载 | ||
| 361 | + | ||
| 362 | +[zy-java-sdk](https://zeyi-tms-product.oss-cn-hangzhou.aliyuncs.com/file/jar/java-sdk/zy-java-sdk-1.0.0.jar) | ||
| 363 | + | ||
| 364 | + | ||
| 365 | + | ||
| 366 | +### 2023-04-21更新日志 | ||
| 367 | + | ||
| 368 | +初始化接口 | ||
| 0 | \ No newline at end of file | 369 | \ No newline at end of file |