up

README.md

@@ -12,6 +12,8 @@
     - [更新登陆凭证接口](#%E6%9B%B4%E6%96%B0%E7%99%BB%E9%99%86%E5%87%AD%E8%AF%81%E6%8E%A5%E5%8F%A3)
 - [运单类接口](#%E8%BF%90%E5%8D%95%E7%B1%BB%E6%8E%A5%E5%8F%A3)
     - [创建运单接口](#%E5%88%9B%E5%BB%BA%E8%BF%90%E5%8D%95%E6%8E%A5%E5%8F%A3)
+- [财务类接口](#%E8%B4%A2%E5%8A%A1%E7%B1%BB%E6%8E%A5%E5%8F%A3)
+    - [核销](#%E6%A0%B8%E9%94%80)
 - [参数说明](#%E5%8F%82%E6%95%B0%E8%AF%B4%E6%98%8E)
     - [运单](#%E8%BF%90%E5%8D%95)
     - [货物](#%E8%B4%A7%E7%89%A9)
@@ -23,21 +25,47 @@
 ## 接口简介(请仔细阅读!)
 
 本文档为网络货运开放接口文档，对接流程为：
-1. 注册并开通网络货运账号（正式环境账号联系实施或者商务，应该已经开通过了）；
+1. 注册并开通网络货运账号（正式环境账号联系我司实施或者商务获取）；
 2. 获取接口访问令牌；
 3. 调用其他接口；
 
 **请使用主账号获取对应的token再调用其他接口!!!**
 
-- **什么是主账号**：即贵公司在我们系统中创建的第一个账号，其后所有的贵公司系统中的账号都是子账号。如果不知道自己是否使用的主账号或者主账号具体是哪个请联系相关负责人。
-- **接口统一URL地址**：测试环境=https://openapi.wlhy.hw.56fanyun.com ，正式环境=待定
-- **测试环境系统地址**：https://wlhy.hw.56fanyun.com
-- **测试环境账号**：联系对接负责人获取。账号并不互通，测试账号对应的是测试环境的域名，正式环境无法使用！
-- **调用接口方式**：`URL` + `?access_token=生成的token`，参数传递使用JSON格式，例：
+相关说明：
+1. **什么是主账号**：
+即贵公司在我们系统中创建的第一个账号，其后所有的贵公司系统中的账号都是子账号。如果不知道自己是否使用的主账号或者主账号具体是哪个请联系相关负责人。
+</br>
+
+2. **接口统一URL地址**：
+测试环境=https://openapi.wlhy.hw.56fanyun.com ，正式环境=待定
+</br>
+
+3. **测试环境系统地址**：
+https://wlhy.hw.56fanyun.com
+</br>
+
+4. **测试环境账号**：
+联系我司对接负责人获取。账号并不互通，测试账号对应的是测试环境的域名，正式环境无法使用！
+</br>
+
+5. **调用接口方式**：
+`URL` + `?access_token=生成的token`，参数传递使用JSON格式。
+`Content-Type: application/json;charset=UTF-8`。例：
 https://wlhy.hw.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c-848c-d08a885095a5
 **请勿将请求参数拼接在URL中传递！**
-- **调试接口**： 推荐使用Postman，或者访问接口URL，会跳转至调试界面
+</br>
+
+6. **调试接口**：
+推荐使用Postman，或者访问接口URL，会跳转至调试界面
+</br>
 
+7. **时间格式**：
+如无特殊说明，接口中所有时间均使用时间戳，精确到秒
+</br>
+
+8. **调用限制**：
+为防止恶意攻击和滥用，接口都加上了调用限制，不同接口限制不同，请参考接口中调用限制的相关说明。例：60次/分钟，表示一分钟内最多请求60次，超过限制会拒绝请求，返回`操作太频繁`。
+</br>
 
 ## 接口说明
 
@@ -51,20 +79,20 @@ https://wlhy.hw.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c-
 - **message**：错误信息，当接口调用失败（状态码为 非200）时，返回的错误信息
 - **data**：返回数据，接口调用成功（状态码为 200）之后返回的数据
 
-**如无特殊说明，接口中所有时间均使用时间戳，精确到秒**
-
 
 # 接口凭证
 
 ## 获取登陆凭证接口
 
-**简要描述：** 获取登陆凭证
+**简要描述：** 获取登陆凭证，accessToken有效期`72小时`，refreshToken有效期`100天`，有效期内获取token返回的结果一样，accessToken到期后建议使用refreshToken进行刷新，而不是使用用户名密码重新获取
 
 **请求 URL：** `/user/generate_access_token`
 
 **请求方式：** GET, POST
 
-**需要Token：** 否
+**需要AccessToken：** 否
+
+**调用限制：** 60次/分钟
 
 **请求参数：**
 
@@ -91,7 +119,7 @@ https://wlhy.hw.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c-
 
 ```java
 {
-    "status": 500,
+    "code": 500,
     "message": "账号或密码不正确"
 }
 ```
@@ -99,13 +127,15 @@ https://wlhy.hw.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c-
 
 ## 更新登陆凭证接口
 
-**简要描述：** 更新登陆凭证
+**简要描述：** 更新登陆凭证，更新后原token将失效
 
 **请求 URL：** `/user/refresh_access_token`
 
 **请求方式：** GET, POST
 
-**需要Token：** 否
+**需要AccessToken：** 否
+
+**调用限制：** 60次/分钟
 
 **请求参数：**
 
@@ -132,7 +162,7 @@ https://wlhy.hw.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c-
 
 ```java
 {
-    "status": 500,
+    "code": 500,
     "message": "账号或刷新凭证不正确"
 }
 ```
@@ -147,21 +177,20 @@ https://wlhy.hw.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c-
 
 **请求方式：** POST
 
-**需要Token：** 是
+**需要AccessToken：** 是
 
-**调用限制：** 
+**调用限制：** 10000次/小时
 
 **请求参数：**
 
 |名称|说明|类型|
 |---|---|---|
-|**orders**  <br>*必填*|受理单列表|< [运单](#运单) > array|
+|**orders**  <br>*必填*|运单列表  <br>**长度** : `1 - 50`|< [运单](#运单) > array|
 
 **返回示例**
 
 - 调用成功示例
 
-调用成功但是系统中查看不到时请先阅读<a href="PROBLEMS.md#通过创建接口创建的订单或受理单登陆系统以后没有查看到">常见问题</a>
 ```java
 {
     "code": 200,
@@ -173,11 +202,58 @@ https://wlhy.hw.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c-
 
 ```java
 {
-    "status": 500,
+    "code": 500,
     "message": "订单创建失败"
 }
 ```
 
+# 财务类接口
+
+## 核销
+
+**简要描述：** 核销
+
+**请求 URL：** `/writeoff/writeoff`
+
+**请求方式：** POST
+
+**需要AccessToken：** 是
+
+**调用限制：** 120次/分钟
+
+**请求参数：**
+
+|名称|说明|类型|
+|---|---|---|
+|**carNumber**  <br>*必填*|车牌号码  <br>**长度** : `1 - 35`|string|
+|**customerOrderNumbers**  <br>*必填*|结算受理单列表|< string > array|
+|**driverName**  <br>*必填*|司机名称  <br>**长度** : `1 - 30`|string|
+|**driverPhone**  <br>*必填*|司机电话  <br>**长度** : `1 - 18`|string|
+|**payFreight**  <br>*必填*|支付金额  <br>**最小值** : `0`  <br>**最大值** : `999999`|number (double)|
+|**payType**  <br>*必填*|支付方式，1：油卡，2：现金，3：支付宝，4：微信，5：银行转账，6：其它|integer (int32)|
+|**tradeNo**  <br>*必填*|资金流水号  <br>**长度** : `1 - 50`|string|
+|**note**  <br>*可选*|付款备注  <br>**长度** : `0 - 256`|string|
+
+- 调用成功示例
+
+```java
+{
+    "code": 200,
+    "data": true,
+    "message": null
+}
+```
+- 调用失败示例
+
+```java
+{
+    "code": 500,
+    "message": "xxxxxxxx"
+}
+```
+
+
+
 # 参数说明
 
 ## 运单