调用第三方物流接口快递寄件下单api接口对接

  电商售后退货快递寄件下单预约快递员上门取件接口对接,调用快递鸟提供的上门取件API标准接口,成功调用后,快递员会准时上门取件,同时支持快递单号物流轨迹查询,快递鸟物流单号查询api接口不区分开发语言,支持Java,C#,PHP,Python,ObjectC等开发语言的程序调用。

  1 接口规范说明

  1.1 接口规范及说明

调用第三方物流接口快递寄件下单api接口对接

  1.1.1 报文及报文编码

  报文格式:Json格式

  请求方法的编码格式(utf-8):交互协议上*用UTF-8,避免传递中文数据出现乱码。

  1.1.2 接口数据包结构

  图例- 数据包结构(系统级{数据})

  1.1.3 JSON示例

  1.1.4 系统级参数

  *快递下单类接口*使用此系统级参数,根据不同的请求接口指令接入不同的接口。

  1.1.5 流程示意图

  1.1.6 名词定义

  1.2 签名说明

  1.2.1 关于签名

  快递鸟和第三方电子商务公司系统进行对接,有一定的安全机制。采用IP认证加签名的方式对接,具体方案如下:

  1.防止数据被篡改

  2.注:

  DataSign生成后,对方接收到数据后,以同样的算法进行签名(推送接口RequestType为101/102不需要进行URL编码),生成摘要,对比两者的摘要是否相同,如果不同,说明传递过程中发生数据篡改。

  2.调用接口的身份认证

  注册成为快递鸟用户后,会生成对应的用户ID和APIKey,用户ID相当于用户名,APIKey相当于*。

  举例:

  1.假设

  2.那么DataSign签名的内容为

  3.接收方收到数据后,获得

  EBusinessID 和RequestData和DataSign等这几个数据。

  4.接收方对EBusinessID得到APIKey,RequestData+APIKey的数据进行

  md5和base64后的内容就为

  OWFhM2I5N2ViM2U2MGRkMjc4YzU2NmVlZWI3ZDk0MmE=

  5.接收方判断签名后的数据跟传递过来的DataSign是否一致,如果一致进行业务操作,如果不一致返回错误。

  1.2.2 (C#)DataSign签名加密代码

  1.3 接入步骤

  1.快递鸟官网注册*成为快递鸟用户;

  快递鸟提供的用户ID是调用接口服务的身份证明,不可更改、不可转用,API Key是应用访问API的签名附加密钥,必须妥善保存。两者关系类似于用户名和*,两者都会在签名和业务参数中使用。

  2.登陆用户后台,进行实名认证,并开通会员服务;

  3.根据技术文档进行开发并在调试平台测试联调;

  快递鸟提供各个API接口的DEMO(包括:.Net版本、Java版本、PHP版本)供开发参考。

  4.系统发布上线。

  注意:测试环境中获取的测试快递单号不可用于实际发货。

  2 下单类接口

  2.1 上门取件-下单

  2.1.1 功能说明

  1. 此接口用于通知快递公司快递员上门揽件。

  2.1.2 基本信息

  2.1.3 接口规则

  1. 请求报文中不允许出现以下特殊字符:’ ” # & + < > % 2. 预约时提供的收寄方信息必须真实准确。3. 用户提供的寄件地址若超出快递公司服务范围,则无快递员上门揽件。4. 因用户原因(如:恶意下单、批量下单长时间不发货等)导致快递公司投诉超过3次,快递鸟将停用此用户接口权限。5. 预约时间段:9点-17点可预约当天上门,17点-次日9点前,预约次日上门全国(除特殊区域):当前时间:9点前 可预约时间段:预约当天任意时间段上门当前时间:11点前 可预约时间段:11点后预约当天任意时间段上门当前时间:13点前 可预约时间段:13点后任意时间段上门当前时间:15点前 可预约时间段:15点后任意时间段上门当前时间:17点前 可预约时间段:17点-19点当前时间:17-次日9点前,预约次日任意时间段上门特殊区域:(西北6省(甘肃、青海、宁夏、陕西、新疆、西藏),东北三省(辽宁省、吉林省、黑龙江省),海南省)当前时间:11点前 可预约时间段:19点前当前时间:11-17点前 可预约时间段:19点前当前时间:17-次日9点前,预约次日19点前

  2.1.4 应用场景

  电商平台、打单工具、ERP系统、WEB端、APP移动端、小程序、集团*结算运费

  2.1.5 应用级参数

  请求示例:

  2.1.6 返回参数

  2.2 上门取件-订单取消

  2.2.1 功能说明

  此接口用于取消“上门取件接口”下单成功的订单。

  2.2.2 基本信息

  2.2.3 接口规则

  1. 只支持取消通过上门取件接口下单成功的订单;

  2. 已揽件状态后不允许取消;提示“您的订单已揽件,不可取消订单”;

  3. 距离预约开始剩余5分钟至预约结束时间加2小时不能取消订单,提示“您的订单在正常服务时间内,不可取消订单”;

  4. 其它时间均可取消订单提示“您的订单已取消成功”。

  2.2.4 应用级参数

  请求示例:

  2.2.5 返回参数

  返回示例:

  2.3 上门取件-订单状态推送

  2.3.1 功能说明

  接口逻辑说明:向快递公司预约后,由快递公司推送订单状态(包含成功和失败的状态及原因)给快递鸟,快递鸟字段转换后,再通过RequestType :103实时推送给客户;(注:订单状态数据在快递鸟后台保存7天,推送失败时的重推机制:同轨迹推送接口);商家端:支持客户通过上门取件接口1801接口的预约指令;

版权声明:以上文章转载自互联网用户,该文观点仅代表作者本人。文章内容仅供参考,不构成建议,不代表快递查询网立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如有侵权请联系:1048208551@qq.com,将立刻删除。

上一篇 2024年05月07日
下一篇 2024年05月07日