本文档详细介绍了中国邮政新一代寄递平台的国际业务出口运单轨迹信息获取接口。文档首先描述了通用技术规范,定义了新一代寄递平台与外部系统(记为XX系统)之间的接口规范。这些接口规范旨在支持新一代寄递平台与外部系统之间的数据同步,确保系统集成各方能够明确自身的职责和任务,同时保证数据在传输和导入处理中的完整性和准确性。
文档中规定了接口的数据格式、通讯格式和交换方式。特别强调了数据交互采用的是JSON格式,并要求接口开发双方按照约定的JSON消息格式(包括消息头和消息体)进行数据封装和解析工作。JSON是一种轻量级的数据交换格式,基于ECMAScript的一个子集,完全独立于语言,采用文本格式。
接口包括请求报文和响应报文两个部分,均通过HTTP POST请求同步获取数据。请求报文的编码格式为“application/x-www-form-urlencoded;charset=UTF-8”,而响应报文则在数据传输过程中保证标准的JSON格式嵌套。
消息头中的每个属性都被视为一个参数,而消息体则整体作为一个参数。消息头中的“dataDigest”字段用于签名验证,签名算法采用MD5方式,将通知内容(json格式)与系统ID结合后进行MD5运算,最终转换成Base64字符串。
请求报文包含了如下字段:发送方标识(sendID)、数据生产的省份代码(proviceNo)、消息类别(msgKind,如“JDPT_XXX_TRACE”)、消息唯一序列号(serialNo)、消息发送日期时间(sendDate)、接收方标识(receiveID)、批次号(batchNo)、数据类型(dataType)。
消息体采用了JSON格式字符串,并规定编码格式为UTF-8。数据通常为数组结构,其最大长度为30,每个数据项为具体字段组成的对象类型。例如,运单轨迹信息可能包含如下字段:跟踪号(traceNo)、操作时间(opTime)、操作机构代码(opOrgCode)和操作代码(opCode)。
响应报文结构与请求报文类似,但主要由服务端对客户端的请求进行响应。消息头包括相同的字段,但是数据值可能不同。响应报文中的消息体也采用标准JSON格式嵌套,用于反馈请求结果或相关信息。
整个接口规范的编写者、审核者和批准人均为张勇,文档的编写、审核和批准日期分别为2019年7月21日、2019年8月8日和2019年7月21日。接口规范书的版本号为1.0.0。
文档的核心目的在于为邮政寄递平台与外部系统之间提供标准化的接口,用于国际业务出口的运单轨迹信息的获取。这有助于提升服务质量,实现数据共享和信息追踪,对于提升快递物流效率,优化用户体验等方面具有重要作用。
评论0