Bläddra i källkod

docs(REAMME): 更新文档说明

gmw 4 år sedan
förälder
incheckning
afb80693c6
1 ändrade filer med 27 tillägg och 30 borttagningar
  1. 27 30
      README.md

+ 27 - 30
README.md

@@ -5,8 +5,8 @@
 <!-- TOC -->
 
 - [网络货运开放接口文档](#%E7%BD%91%E7%BB%9C%E8%B4%A7%E8%BF%90%E5%BC%80%E6%94%BE%E6%8E%A5%E5%8F%A3%E6%96%87%E6%A1%A3)
-    - [接口简介(请仔细阅读!)](#%E6%8E%A5%E5%8F%A3%E7%AE%80%E4%BB%8B%E8%AF%B7%E4%BB%94%E7%BB%86%E9%98%85%E8%AF%BB)
-    - [接口说明](#%E6%8E%A5%E5%8F%A3%E8%AF%B4%E6%98%8E)
+    - [接口简介:](#%E6%8E%A5%E5%8F%A3%E7%AE%80%E4%BB%8B)
+    - [相关说明(请仔细阅读!):](#%E7%9B%B8%E5%85%B3%E8%AF%B4%E6%98%8E%E8%AF%B7%E4%BB%94%E7%BB%86%E9%98%85%E8%AF%BB)
 - [接口凭证](#%E6%8E%A5%E5%8F%A3%E5%87%AD%E8%AF%81)
     - [获取登陆凭证接口](#%E8%8E%B7%E5%8F%96%E7%99%BB%E9%99%86%E5%87%AD%E8%AF%81%E6%8E%A5%E5%8F%A3)
     - [更新登陆凭证接口](#%E6%9B%B4%E6%96%B0%E7%99%BB%E9%99%86%E5%87%AD%E8%AF%81%E6%8E%A5%E5%8F%A3)
@@ -22,54 +22,51 @@
 
 <!-- /TOC -->
 
-## 接口简介(请仔细阅读!)
+## 接口简介
 
 本文档为网络货运开放接口文档,对接流程为:
 1. 注册并开通网络货运账号(正式环境账号联系我司实施或者商务获取);
-2. 获取接口访问令牌;
-3. 调用其他接口;
+2. 使用网络货运的账号密码获取接口访问令牌(accessToken)
+3. 使用`accessToken`调用其他接口;
 
 **请使用主账号获取对应的token再调用其他接口!!!**
 
-相关说明:
-1. **什么是主账号**:<br>
-即贵公司在我们系统中创建的第一个账号,其后所有的贵公司系统中的账号都是子账号。如果不知道自己是否使用的主账号或者主账号具体是哪个请联系相关负责人。
+## 相关说明(请仔细阅读!):
+1. **什么是主账号**:<br>即贵公司在我们系统中创建的第一个账号,其后所有的贵公司系统中的账号都是子账号。如果不知道自己是否使用的主账号或者主账号具体是哪个请联系相关负责人。
 
-2. **接口统一URL地址**:<br>
-测试环境=https://openapi.wlhy.hw.56fanyun.com ,正式环境=待定
+2. **接口统一URL地址**:<br>测试环境=https://openapi.wlhy.hw.56fanyun.com ,正式环境=待定
 
-3. **测试环境系统地址**:<br>
-https://wlhy.hw.56fanyun.com
+3. **测试环境系统地址**:<br>https://wlhy.hw.56fanyun.com
 
-4. **测试环境账号**:<br>
-联系我司对接负责人获取。账号并不互通,测试账号对应的是测试环境的域名,正式环境无法使用!
+4. **测试环境账号**:<br>联系我司对接负责人获取。账号并不互通,测试账号对应的是测试环境的域名,正式环境无法使用!
 
-5. **调用接口方式**:<br>
-`URL` + `?access_token=生成的token`,参数传递使用JSON格式。
+5. **调用接口方式**:<br>`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中传递!**
 
-6. **调试接口**:<br>
-推荐使用Postman,或者访问接口URL,会跳转至调试界面
+6. **调试接口**:<br>推荐使用Postman,或者访问接口URL,会跳转至调试界面
 
-7. **时间格式**:<br>
-如无特殊说明,接口中所有时间均使用时间戳,精确到秒
+7. **时间格式**:<br>如无特殊说明,接口中所有时间均使用时间戳,精确到秒
 
-8. **调用限制**:<br>
-为防止恶意攻击和滥用,接口都加上了调用限制,不同接口限制不同,请参考接口中调用限制的相关说明。例:60次/分钟,表示一分钟内最多请求60次,超过限制会拒绝请求,返回`操作太频繁`。
+8. **调用限制**:<br>为防止恶意攻击和滥用,接口都加上了调用限制,不同接口限制不同,请参考接口中调用限制的相关说明。例:60次/分钟,表示一分钟内最多请求60次,超过限制会拒绝请求,返回`操作太频繁`。
 
-## 接口说明
+9. **状态码**:
 
-所有接口支持RESTful的方式访问,返回结果首先判断http状态码,有如下几种情况:
+|状态码|说明|
+|:---:|---|
+|200|调用接口成功|
+|401|授权失败,需要重新登陆获取access_token|
+|404|接口不存在,请检查调用的接口地址,协议的格式是否正确|
+|500|服务异常,具体错误原因会在返回结果中说明|
 
-1. 404表示接口不存在,请检查调用的接口地址,协议的格式是否正确
-2. 401表示授权失败,需要重新登陆获取access_token
-3. 200,201,20*表示调用接口成功,返回body中调用结果,是http JSON格式的,包含以下字段
+10. **返回字段**:
 
-- **code**:状态码,取值有 200,非200;200 表示接口调用成功, 非200 表示接口调用失败
-- **message**:错误信息,当接口调用失败(状态码为 非200)时,返回的错误信息
-- **data**:返回数据,接口调用成功(状态码为 200)之后返回的数据
+|名称|说明|
+|:---:|---|
+|code|状态码|
+|data|返回数据,接口调用成功(状态码为 200)之后返回的数据|
+|message|错误信息,当接口调用失败(状态码为 非200)时,返回的错误信息,调用成功时返回null|
 
 
 # 接口凭证