项目需求说明书.doc

快递查询平台
项目需求说明书
项目名称
客户A快递查询平台
文件名
项目需求说明书
文件编号
[项目编号]
文件状态
草稿/正式发布(Error! Reference source not found.)
撰写人
审核人
发布日期
2018年05月21日
修订历史记录
A - 增加 M - 修订 D - 删除
版本号
日期
修改人
摘要

2018-5-14
客户A快递邮寄查询项目需求初始版本
目录
1 客户业务及需求相关术语 4
客户业务相关术语 5
业务: 5
快递反馈接口报文 5
客户A接口设计 8
技术术语 14
2 项目目标 14
3 客户限制 14
4 客户联系 14
5 业务框图 14
6 人机界面要求 15
客户业务及需求相关术语
本节内容主要说明客户相关的业务相关的用语,以便在后续的项目推进中双方形成共同语言。
我司与快递的反馈接口:
接口说明:快递公司主动发起请求把邮件的收寄、投递、封发、开拆等信息推送到客户方,我司需要提供一个接口服务。
采用技术:Http请求
方式:POST
请求服务地址:由我司提供
请求的授权信息:
下面数据项要设置到Http的Head上面
授权信息 authenticate=由客户方提供授权码、version=速递服务的版本号(授权码是指客户跟速递双方约定好的一个接口授权密钥)
接口的数据格式Content-Type=text/xml; 或者Content-Type=text/json;此格式表明本次反馈所使用的数据格式,该格式可以根据用户的不同需要来进行配置。
反馈加密处理需知(客户如果需要反馈加密报文则进行加密,加密流程通过邮件来确定加密方式)
我司与客户A的相关接口:
1、推送快递单号接口说明
默认为每5分钟(可参数配置)将有更新的快递单号全部进行推送,每笔推送消息报文最多包含50笔(可参数配置)快递单号,如超过50笔则拆分为多次推送请求推送过来(无需再等待5分钟)。
每次请求中同一配送商的快递单号不能重复。
接口响应时间限制为1分钟,超时的订单将进行重新推送。
2、查询物流详情接口说明
每次可查询同一配送商同一订单号下的一条或多条状态信息。
接口响应时间限制为1分钟,超时则进行下一次请求。
请求报文中logId(日志ID)为0时表示请求该订单所有状态日志。否则表示请求该条日志ID之后(不含此ID号)的所有订单状态日志。
客户业务相关术语
业务:
快递反馈接口报文
反馈的数据报文如下:
Xml反馈报文格式
<?xml version="" encoding="UTF-8"?>
<listexpressmail>
<expressmail>
<serialnumber>00000000000000000001</serialnumber>
<mailnum></mailnum>
<procdate>20130702</procdate>
<proctime>000100</proctime>
<orgfullname>所在地名称</orgfullname>
<action>00</action>
<description>描述信息</description>
<effect>有效、无效</effect>
<properdelivery>妥投使用</properdelivery>
<notproperdelivery>未妥投使用</notproperdelivery>
</expressmail>
</listexpressmail>
Json反馈报文格式:
{"listexpressmail": [
{
"serialnumber":"00000000000000000001",
"mailnum": "",
"procdate": "20130702",
"proctime": "000100",
"orgfullname": "所在地名称",
"action": "00",
"description": "描述信息",
"effect":"",
"properdelivery":"",
"notproperdelivery":""
}
]}
服务端的响应报文:
Xml:
<?xml version="" encoding="UTF-8"?>
<response>
<ess>0</ess>
<failmailnums></failmailnums>
<remark></remark>
<