概述

文档概述

本文档描述了DMS系统与TMS系统进行交互所涉及到功能和参数,作为承运商接入时的参考。接口包含DMS系统同步订单信息接口(DMS->TMS)、TMS系统回传订单状态轨迹接口(TMS->DMS)。

名词解释

TMS:TransportationManagementSystem物流管理系统

DMS:DeliveryManagementSystem配送管理系统

阅读对象

商户接口开发人员、测试人员、维护人员。

方案概述

系统交互

交互图

相关约定

  • 通讯约定:使用HTTPPOST方式进行通讯,参数做encode(URL转码)。
  • 参数大小写约定:没有强制要求的地方,统一使用小写。
  • 编码约定:UTF-8。
  • 参数约定:JSON格式。
  • 签名约定:签名生成公式:MD5(timeStamp+keyValue),keyValue由DMS开发商指定。
  • 报文中时间约定:时间格式使用YYYY-MM-DDHH:mm:ss的格式,精确到秒。
  • 字段类型约定:需要严格依据字段表格中给出的参数格式和大小进行开发,避免类型不匹配或参数大小预留不够导致溢出。
  • 字段解析约定:参数字段中的必选字段是每次调用接口时都要求必须传入的。而可选字段会根据业务场景需求有差别(在某些特殊业务场景下,可选也有可能是必选)。所以在开发时,可选字段数据为空时,字符类型默认传递”“,数字类型默认传递0。由于DMS使用HTTPPOST方式进行交互,数据将以POST方式提供给指定的URL地址。TMS需要自行搭建与DMS匹配的交互环境(支持HTTPPOST,确保通讯正常)。TMS合作伙伴需提供给DMS接口交互的URL。DMS系统抛送格式为Data=jsonData.

数据安全

为了保证数据传输过程中的数据真实性和完整性,我们需要对数据进行加密,收到消息后,一定要验证数据是否完整正确。 数据安全性验证采用MD5加密。待加密串+keyValue进行MD5签名验证。