快递查询平台API接口文档

文档说明

• 运行平台：nodejs

• 服务器语言：NodeJS+mysql

• 服务器地址：www.softeem.xin

• 编写人员：杨标

• 编写时间：2019年9月10日星期二

一、获取快递公司

1. 描述

该功能主要是用于获取当前项目里面所有的快递信息

2. 请求地址

   操作名称	/Api/KuaiDi/getKuaiDiCom
   协议	https
   请求方式	GET
   URL全径	请参考第5点

3. 请求参数

   无

4. 返回数据

   返回的数据是一个json数组，里面字段如下

   序号	名称	类型	备注
   1	key	String	快递公司编码
   2	com	String	快递公司名称

5. 请求URL实例

   https://www.softeem.xin/Api/KuaiDi/getKuaiDiCom

6. 返回数据实例

   说明	实例
   Json数据实例	[ { "key": "BTWL", "com": "百世快运"},....... ]

二、查询快递信息

1. 描述

   该功能根据快递的类型与快递单号查询快递信息

2. 请求地址

   操作名称	/Api/KuaiDi/getKuaiDiInfo
   协议	https
   请求方式	GET
   URL全径	请参考第5点

3. 请求参数

   序号	参数名	中文名称	必选	数据类型	长度	备注
   1	type	快递公司编号	Y	String		快递公司信息的key
   2	postId	快递单号	Y	String		用户输入的快递单号

4. 返回数据

   返回的数据是一个json数对象，快递的主要信息在Traces里面

   序号	名称	类型	备注
   1	AcceptStation	String	快递处理内容
   2	AcceptTime	String	快递处理的时间

   完整信息

   序号	名称	类型	备注
   1	LogisticCode	String	用户要查询的快递单号
   2	ShipperCode	String	用户要查询的快递公司名称编码
   3	Traces	Array	快递的主要信息，详细情况见上表
   4	State	String
   5	EBusinessID	String	接口ID，请用户忽略
   6	Success	Boolean	true代表成功，false代表失败

5. 请求URL实例

   https://www.softeem.xin/Api/KuaiDi/getKuaiDiInfo?type=xxxx&postId=xxxx

6. 返回数据实例

   说明	实例
   Json数据实例	{ "LogisticCode": "900711472634", "ShipperCode": "UC", "Traces": [ { "AcceptStation": "[晋江英林]【董洁】已收件", "AcceptTime": "2019-07-27 17:30:52" }, ........ ], "State": "3", "EBusinessID": "1308237", "Success": true}