顺丰API接口对接文档：XML版详细说明
需积分: 0 66 浏览量
更新于2024-06-26
收藏 307KB DOCX 举报
"SF顺丰XML版本接口对接文档是针对历史接口的参考，旨在帮助开发者集成顺丰企业服务平台（BSP），实现物流供应链一体化。接口规范包括UTF-8编码的XML报文，HTTP/POST通信协议，以及校验码的生成规则。接口基本信息包括服务名称、是否支持批量交易、接口类型（接入或推送）等。请求和响应XML报文有固定格式，包含服务名、接入编码、语言设置等要素。"
在顺丰的XML接口对接中，关键知识点包括：
1. **接口编码与格式**：所有接口使用UTF-8编码的XML报文，确保数据传输中的中文字符正确性。Oracle数据库也以UTF-8编码存储数据。
2. **报文结构**：请求XML报文由`<Request>`元素包裹，包含`service`属性定义服务名和`lang`属性定义响应语言。`<Head>`元素中包含接入编码，而`<Body>`元素封装请求数据。
3. **响应报文**：响应XML报文的`<Head>`元素会返回"OK"或"ERR"，表示交易状态，"OK"为成功，"ERR"为失败。批量交易场景中只有全成功或全失败。
4. **通讯协议**：接口通信采用HTTP/POST协议。XML报文通过`xml`参数传递，校验码通过`verifyCode`参数传递。
5. **校验码生成**：校验码基于XML报文和分配的“密钥”（checkword）生成，通过MD5编码和Base64编码两步加密。
6. **接口分类**：BSP接口分为接入接口和推送接口，根据功能不同进行区分。
7. **接口基本信息**：每个接口都有特定的服务名称，是否支持批量交易（如适用），以及接口类型（接入或推送）。
8. **语言支持**：支持中文简体（zh-CN）、繁体（zh-TW、zh-HK、zh-MO）和英文（en）。
对接这些接口时，开发者需要理解并遵循上述规范，确保数据安全性和接口调用的准确性。同时，需要注意顺丰可能会对新接口使用JSON格式，因此在开发过程中要根据实际情况选择合适的接口版本和数据格式。
企业服务平台技术规范 – 下订单（含筛选）接口
第 15 页 /共 135 页
©版权所有 2015 顺丰科技有限公司
#
属性名
类型（约
束）
必填
默认值
描述
19
d_deliverycode
String(30)
条件
到件方代码，如果是跨境
件，则必传此字段，用于表
示到方国家的城市。若某国
家整体是以代理商来提供服
务的，则此字段需要传国家
编码。
20
d_country
String(30)
否
到方国家
21
d_province
String(30)
否
到件方所在省级行政区名
称，必须是标准的省级行政
区名称如：北京、广东省、
广西壮族自治区等；此字段
影响目的地代码识别，建议
尽可能传该字段的值。
进出口件一定必填
22
d_city
String(100)
否
到件方所在地级行政区名
称，必须是标准的城市称谓
如：北京市、深圳市、大理
白族自治州等；此字段影响
目的地代码识别，建议尽可
能传该字段的值。
进出口件一定必填
23
d_county
String(30)
否
到件方所在县/区级行政区名
称，必须是标准的县/区称
谓，如：福田区，南涧彝族
自治县、准格尔旗等。
剩余134页未读，继续阅读
1453 浏览量
2677 浏览量
5482 浏览量
325 浏览量
276 浏览量
285 浏览量
2024-10-25 上传
178 浏览量
2024-09-20 上传
