快递鸟API电子面单接口说明文档
快递鸟电子面单接口说明文档
快递鸟
2017-04-25
版本
一、前言
1、业务背景
随着电子商务和物流信息化服务的迅猛发展，电子面单已经成为了商家快速发货并连接订单与物流的有力工具。快递鸟电子面单接口是快递鸟提供给独立电商、仓储管理系统、打单软件、物流供应链等物流系统平台使用的物流下单接口，满足商家在线发货需求并提供打印电子面单的服务。商家通过贵司系统选择物流公司发送请求通知快递公司有快递要发货，贵公司把数据通过此接口转发到快递鸟，由快递鸟为商家通知对应的快递公司快递员上门取件。电子面单成功下单后，快递鸟系统内将自动订阅，一旦轨迹发生变化时，快递鸟将调用贵司推送接收接口将物流信息反向推送至商家。同时若客户使用代收货款服务，快递鸟会将代收货款的货款状态独立推送给商家用户。
电子面单具有如下特点：
●打印效率高
相比传统针式打印机套打模式，打印速度提升6-8倍，热敏打印机打印速度平均30-40张/分。
●发货效率高
包裹出库时减少了抽底单的工序，降低了操作成本、提升操作效率，运单和订单即时绑定，无需人工再次扫描绑定发货。
目前商家在使用电子面单的过程中也存在一些情况导致部分用户无法顺畅使用，例如：
●大电商有多家合作快递公司，各家快递公司的模板尺寸不一，需要使用多个打印机
打印面单。
●单号作废后回收机制不完善导致电商成本升高。
●二联电子面单无底单，运费核账存在问题（部分商家货物重量以称重为准）。
●打印时发现面单号余额不足，耽误发货。
●小B电商发货量不够申请网点的电子面单服务。
快递鸟电子面单接口为解决客户以上问题，新增如下解决方案：
●电子面单余量查询：可通过电子面单余量查询接口查询，并且在快递鸟官网可设置
余额不足提醒值（后续会加上余额不足短信/邮件提醒功能）
●电子面单取消/回收：可通过电子面单取消接口，回收部分加盟快递公司的面单号。
●通用电子面单模板，含二联、三联模板
●快递公司电子面单客户号在线申请
●散户模式电子面单：部分快递公司无需申请电子面单客户号即可直接打印电子面单。
二、快递鸟电子面单方案
1、编码规范
目前接口支持了：顺丰（SF）、EMS（EMS）、宅急送（ZJS）、圆通（YTO）、百世快递（HTKY）、中通（ZTO）、韵达（YD）、申通（STO）、德邦（DBL）、优速（UC）、京东（JD）、信丰（XFEX）、全峰（QFKD）、跨越速运（KYSY）、安能小包（ANE）、快捷快递（FAST）、国通（GTO）、天天快递（HHTT），后续更多的快递公司正在对接中。
散户模式（无需电子面单客户号）支持快递公司：顺丰（SF）、EMS（EMS）（仅支持广东省内发货）、快捷快递（FAST）、宅急送（ZJS），后续更多的快递公司正在对接中。
电子面单客户号在线申请支持快递公司：优速（UC）、后续更多的快递公司正在对接中。
余量查询接口支持快递公司：中通（ZTO）、韵达（YD）、优速（UC）、后续更多的快递公司正在对接中。
面单回收接口支持快递公司：优速（UC）、后续更多的快递公司正在对接中。
2、业务流程
?商家需要做什么
●商家使用流程
●配置物料
a)电子面单需要使用热敏打印机，可与当地网点申请或自行通过淘宝、京东等电商平
台购买，目前市场上支持的厂家和型号包括：斑马G886T、启锐、佳博等
b)打印纸：电子面单需要使用热敏纸，可与当地网点申请打印纸物料或者自行在淘宝
等电商平台、线下文具店购买，打印纸尺寸需要根据打印模板尺寸购买或定制。
●商家在线申请电子面单客户号
截图：申请服务商的界面截图
截图：申请服务商的提交界面截图
选择网点：网点为根据发货地址自动匹配，若有多个需您自行选择，快递公司总部审核通过后会分配正确的网点。
●申请快递公司电子面单客户号说明：
a)电子面单客户号即请求打印面单时的用户账号或月结编码或客户编码，不同物流服
务商的叫法不同而已。
b)若商家无需月结运费，电子面单API请求参数CustomerName“电子面单客户账号”
无需填写可直接请求打单，无需申请电子面单客户号。支持快递公司：顺丰（SF）、
EMS（EMS）（仅支持广东省内发货）、快捷快递（FAST）、宅急送（ZJS），后续更多
的快递公司正在对接中。
c)若商家已有电子面单客户号，则对接快递鸟电子面单API请求参数CustomerName
“电子面单客户号”输入商家的客户号和密码通过验证即可打单。
d)在线申请客户号说明：因为物流快递商运营模式的不同（分为加盟和直营），加盟
型运营商是以网点为单位进行账户核算，所以您需要和每个快递网点建立合作，通
过快递鸟申请服务后，网点会联系您审核并且办理单量充值。而直营型服务商由快
递总部与发货人绑定运费结算关系，无需再联系快递公司充值单号，直营快递公司
审核通过后即可打单。
目前支持在线申请客户号的快递公司：优速（UC），后续更多的快递公司正在对接中。
●电子面单余量提醒值设置
快递鸟官网-用户管理后台-电子面单-账户信息-批量设置余量不足提醒值。
?系统对接需要做什么
●快递鸟接口对接通用流程：
电子面单接口对接流程：
a)注册快递鸟ID：
b)实名认证：
c)申请电子面单API：在快递鸟用户管理后台--申请API页面，点击申请电子面单API，快
递鸟审核通过后即可开始对接。
d)对接联合注册接口：若贵司平台系统有多家发货商家，建议同时对接联合注册接口，以
便区分您平台用户，并实现各发货商家独立使用代收货款服务。接口文档参考：《快递鸟代收货款》-1.1 用户注册接口。非必需接入。
e)对接电子面单接口：请参考第三章：接口说明
f)前端界面开发：您需要为商家增加打印电子面单的组件，包括：添加电子面单打印模板
（模板保存在系统本地或通过接口即时在线获取均可）、商家绑定电子面单客户账号（账号、密码、取件网点等信息，具体参考《快递鸟电子面单参数配置对照表》，建议在商家选择快递公司打印模板时让商家输入提交保存。）、打印界面和控件调试（偏移调试）。
3、系统设计规范
添加电子面单打印模板/添加快递公司界面示例：
商家需要绑定电子面单账号信息，建议根据《快递鸟电子面单参数配置对照表》显示各家快递公司需要输入的字段。
4、应用场景说明
下单+打印
a) 商家操作发货时同步订单的发/收件人信息、货物信息，通过接口直接发送到
快递公司获取电子面单单号、大头笔、电子面单打印模板等信息。通过浏览器或CS结构客户端打印工具进行打印电子面单。
?筛单
a)电子面单下单时快递公司需要确认订单是否在收派范围之内，故需要将订单信息的收件
地址和寄件地址进行筛单校验。
?取消/回收单号
a)已生成电子面单运单号的面单，在快递公司未揽件前可申请取消面单。
b)面单号取消后，加盟型快递公司大客户号的面单会按每家快递公司规则回收，余量对应
加1。
c)每个面单号只支持取消一次。
d)每个客户号取消的单号总量不能超过获取单号数量的20%。
e)快递公司回收单号机制配置表如下：
余量查询
a)与网点预充值单量情况下才需要查询余量。散户模式无需查询余量。
b)直营快递公司无需查询余量。
三、接口说明
1.1电子面单
1.1.1功能说明
电子面单接口是快递鸟提供给独立电商、仓储管理系统、物流供应链等物流系统平台使用的下单接口，满足客户在线发货需求并提供打印面单的服务，客户通过网络选择物流公司发送请求通知贵公司有快递要发货，贵公司把数据通过此接口转发到快递鸟，由快递鸟为您通知对应的快递公司快递员上门取件。
电子面单成功下单后，快递鸟系统内将自动订阅，一旦轨迹发生变化时，快递鸟将调用客户方推送接收接口。同时若客户使用代收货款服务，快递鸟会将代收货款的货款状态独立推送给用户。
1.1.2接口规则
(1)、只支持Json格式。接口指令1007。
(2)、订单编号(OrderCode)不可重复提交，重复提交系统会返回具体错误代码。
(3)、目前接口支持了：顺丰（SF）、EMS（EMS）、宅急送（ZJS）、圆通（YTO）、百世快
递（HTKY）、中通（ZTO）、韵达（YD）、申通（STO）、德邦（DBL）、优速（UC）、京东（JD）、信丰（XFEX）、全峰（QFKD）、跨越速运（KYSY）、安能小包（ANE）、快捷快递（FAST）、国通（GTO）、天天快递（HHTT），后续更多的快递公司正在对接中。
散户模式（无需电子面单客户号）支持快递公司：顺丰（SF）、EMS（EMS）（仅支持广东省内发货）、优速（UC）、快捷快递（FAST）、宅急送（ZJS），后续更多的快递公司正在对接中。
(4)、测试地址：
(5)、正式地址：
(6)、请求报文中不允许出现以下特殊字符： ' " # & + < >
1.1.3系统级和应用级输入参数
1.1.4返回结果参数
1.2电子面单余量查询接口
1.2.1功能说明
用户查询客户号在快递公司的单号剩余量。
1.2.2接口规则
(1)、接口只支持Json格式参数，接口指令1127。只支持POST请求方式，utf-8编码。
(2)、目前支持快递公司：优速，后续更多的快递公司正在对接中。
1.2.3系统级和应用级输入参数
1.2.4返回结果参数
1.2.5JSON请求示例1.2.6JSON返回示例
1.3电子面单单号取消
1.3.1功能说明
快递鸟通用接口提交快递公司编码、快递单号，则可以取消提交单号。
仅支持未揽件状态快递单进行取消，取消后的回收规则以快递公司为准。
1.3.2接口规则
(1)、接口指令1147。
(2)、目前支持快递公司：优速，后续更多的快递公司正在对接中。
1.3.3系统级和应用级输入参数
1.3.4返回结果参数
API接口文档
API接口文档 最后更新日期：2013-05-16 一、添加域名接口 (6) 1、接口调用地址 (6) 2、传入参数 (6) 3、输出数据 (6) 二、删除域名接口 (7) 1、接口调用地址 (7) 2、传入参数 (7) 3、输出数据 (7) 三、添加用户接口 (8) 1、接口调用地址 (8) 2、传入参数 (8) 3、输出数据 (8) 四、获取用户信息接口 (9) 1、接口调用地址 (9) 2、传入参数 (9) 3、输出数据 (9) 五、搜索用户接口 (10) 1、接口调用地址 (10) 2、传入参数 (10) 3、输出数据 (10) 六、修改用户接口 (11) 1、接口调用地址 (11) 2、传入参数 (11) 3、输出数据 (12) 七、删除用户接口 (13) 1、接口调用地址 (13) 2、传入参数 (13) 3、输出数据 (13) 八、获取邮箱别名接口 (14) 1、接口调用地址 (14) 2、传入参数 (14) 3、输出数据 (14) 九、获取部门列表接口 (15) 1、接口调用地址 (15) 2、传入参数 (15) 3、输出数据 (15) 十、添加部门接口 (17) 1、接口调用地址 (17)
3、输出数据 (17) 十一、修改部门接口 (18) 1、接口调用地址 (18) 2、传入参数 (18) 3、输出数据 (18) 十二、删除部门接口 (19) 1、接口调用地址 (19) 2、传入参数 (19) 3、输出数据 (19) 十三、获取部门成员接口 (20) 1、接口调用地址 (20) 2、传入参数 (20) 3、输出数据 (20) 十四、添加部门成员接口 (21) 1、接口调用地址 (21) 2、传入参数 (21) 3、输出数据 (21) 十五、删除部门成员接口 (22) 1、接口调用地址 (22) 2、传入参数 (22) 3、输出数据 (22) 十六、添加别名接口 (23) 1、接口调用地址 (23) 2、传入参数 (23) 3、输出数据 (23) 十七、修改别名接口 (24) 1、接口调用地址 (24) 2、传入参数 (24) 3、输出数据 (24) 十八、删除别名接口 (25) 1、接口调用地址 (25) 2、传入参数 (25) 3、输出数据 (25) 十九、获取POP接收邮件接口 (26) 1、接口调用地址 (26) 2、传入参数 (26) 3、输出数据 (26) 二十、添加POP接收邮件接口 (27) 1、接口调用地址 (27) 2、传入参数 (27) 3、输出数据 (27) 二十一、修改POP接收邮件接口 (28) 1、接口调用地址 (28)
系统设计文档模板
系统设计说明书（架构、概要、详细）目录结构 虽然这些文档一般来说公司都是有模板的，但我写这些文档以来基本上是每写一次就把目录结构 给改一次，应该说这是因为自己对这些文档的理解开始加深，慢慢的越来越明白这些文档的作用 和其中需要阐述的东西，觉得这三份文档主要阐述了一个系统的设计和实现过程，从系统分解为层次、层次内的模块以及相互的接口、模块分解为对象以及对象的接口、实现这些对象接口的方法。这次又整了一份，A/ ，欢迎大家指正。 XXX架构设计说明书 （架构设计重点在于将系统分层并产生层次内的模块、阐明模块之间的关系）一?概述 描述本文的参考依据、资料以及大概内容。 二.目的 描述本文编写的目的。 三.架构设计 阐明进行架构设计的总体原则，如对问题域的分析方法。 3.1. 架构分析 对场景以及问题域进行分析，构成系统的架构级设计，阐明对于系统的分层思想。 3.2. 设计思想 阐明进行架构设计的思想，可参考一些架构设计的模式，需结合当前系统的 实际情况而定。 3.3. 架构体系 根据架构分析和设计思想产生系统的架构图，并对架构图进行描述，说明分层的原因、层次的职责，并根据架构图绘制系统的物理部署图，描述系统的部署体系。3.4. 模块划分 根据架构图进行模块的划分并阐明模块划分的理由，绘制模块物理图以及模
块依赖图。 341. 模块描述 根据模块物理图描述各模块的职责，并声明其对其他模块的接口要求。。 3.4.2. 模块接口设计 对模块接口进行设计，并提供一定的伪代码。 XXX概要设计说明书 （概要设计重点在于将模块分解为对象并阐明对象之间的关系） 一.概述 描述本文的参考依据、资料以及大概内容。 二.目的 描述本文的编写目的。 三.模块概要设计 引用架构设计说明书中的模块图，并阐述对于模块进行设计的大致思路。 3.1. 设计思想 阐明概要设计的思想，概要设计的思想通常是涉及设计模式的。 3.2. 模块A 3.2.1. 概要设计 根据该模块的职责对模块进行概要设计（分解模块为对象、描述对象的职责以及声明对象之间的接口），绘制模块的对象图、对象间的依赖图以及模块主要功能的序列图，分别加以描述并相应的描述模块异常的处理方法。 3.2.2. 模块接口实现 阐明对于架构设计中定义的模块接口的实现的设计。 XXX详细设计说明书 （详细设计重点在于对模块进行实现，将模块的对象分解为属性和方法，并阐述 如何实现）
开发接口文档-API文档模板
XXX项目接口文档版本控制信息 获取所有字段 获取所有字段 请求地址：/session/field/findAll 请求参数 响应
请求例子：响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统处理正常！ ","page":0,"pageSize":0,"returnObject":null,"returnValue":{"types":null,"villages":null,"companys":[{"iconColour":"","iconSize":0,"ico nStyle":"","id":4,"name":"XX"},{"iconColour":"","iconSize":0,"iconStyle":"","id":5,"name":"XX"},{"iconColour":"","iconSize":0,"iconSty le":"","id":7,"name":"XX"}]},"totals":0} 文件上传 文件上传（ajax） 请求地址：/session/file/upload 请求参数 响应 请求例子：var formData = new FormData(); ("file", [0]); $.ajax({ url : routePath + "/session/file/upload", type : 'POST', data : formData,
processData : false, contentType : false, success : function(result) { result = (result); if == "10000"){ ('上传成功！'); $("#editHeadPortrait").val } } }); 响应例子：returnValue里包含了 fileName和filePath 字段管理-所属类型 新增所属类型 请求地址：/session/fieldType/save 请求参数 响应 请求例子：响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统处理正常！","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"totals":0}
快递鸟电子面单API接口使用指南
快递鸟电子面单使用手册 V1.0
目录 1 服务介绍 (1) 2 服务价值 (2) 3 准备工作 (2) 3.1申请电子面单客户号及单号 (2) 3.1.1月结模式申请客户号 (3) 3.1.1快递鸟模式直接打印 (9) 3.2购买或充值单号 (9) 3.3准备热敏打印纸及打印机 (9) 4 对接流程 (10) 4.1 自营商家对接流程 (10) 4.2 系统商，电商平台商家对接流程 (15) 5 常见问题 (15)
1服务介绍 快递鸟电子面单API服务，是指由快递公司通过快递鸟电子面单API，向打单用户提供物流单号，实现种通过热敏纸打印输出纸质物流面单并发货的服务。现该服务已支持21家快递公司，57个官方承认模板（含隐私快递），有效提高打印速度4-6倍，一次开发即可接入所有支持快递公司。 目前已支持： 顺丰（SF）、EMS（EMS）、宅急送（ZJS）、圆通（YTO）、百世快递（HTKY）、中通（ZTO）、韵达（YD）、申通（STO）、德邦（DBL）、优速（UC）、京东（JD）、信丰（XFEX）、全峰（QFKD）、跨越速运（KYSY）、安能小包（ANE）、快捷快递（FAST）、国通（GTO）、天天快递（HHTT）、邮政快递包裹（YZPY）、中铁快运（ZTKY），后续更多的快递公司正在对接中。 EMS电子面单模板展示
2服务价值 打印速度提升：电子面单是普通纸质面单的4-6倍，平均每单打印只需花费1-2秒钟，高效率的打单大大缓解电商等客户的大批量打单压力，轻松应对大促。 提高发货效率：传统发货模式，操作员需要将已打出的快递单和订单信息匹配后再发货，电子面单不需要把快递单和定单信息逐一匹配操作，在定单信息申请快递单号的时候就已完成了定单匹配；卖家无需再安排人员专门抽取“发货联”，操作效率进一步提升。 3准备工作 针对自营商家，以下工作可在对接过程中准备，以便对接完成后即可上线立即使用。 平台及系统商可参考如下流程指导平台用户自行准备。 3.1申请电子面单客户号及单号 电子面单客户号即请求打印面单时的用户账号或月结编码或客户编码，不同物流服务商的叫法不同而已。
接口控制文件(模版)
文件修订页
目录 1 范围 (1) 1.1系统概述 (1) 1.2文档概述.................................................................................................错误!未定义书签。 1.3术语与缩略语 (1) 2 引用文档 (1) 3 接口设计 (1) 3.1外部接口 (1) 3.2用户接口 (2) 3.3内部接口 (2)
1 范围 1.1 系统概述 描述软件系统的运行环境、主要用途，描述软件系统的总体功能、构成、子系统构成。使得读者对系统有一个总体的概要的了解。 [读者看完系统概述知道了这个软件是做什么用的、主要的功能是什么，用在什么样的场合。这样读者就可以对系统有一个整体的了解]。 1.2 术语与缩略语 本文档使用的术语与缩略语： XXXX ：XXXXXXXXXXXX； ……； 2 引用文档 [1]《XXXXXXX》，XXXXXXXXXX，YYYY年MM月。 [2]《XXXXXXX》，XXXXXXXXXX，YYYY年MM月。 ……。 3 接口设计 3.1外部接口 说明该系统同外界的所有接口安排，包软件接口与硬件接口。 <说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接口关系。> 例如：通讯接口、直接硬件接口、支撑软件接口以及与其它软件模块间的接口设计。 1）外部网络通讯接口设计 外部通讯网络接口设计是指与本系统范围外的网络接口，如上层管理网等的接口和协议、信息流向、信息、长度和通讯周期等。 2）外部串行口通讯接口设计 外部串行口通讯接口设计是指与本系统范围外的其它系统采用串行口通讯时的接口关系，包括通讯协议(握手方式、波特率、校验方式等)、信息流向、信息长度和通讯周期等。还应说明当通讯过于频繁或超时时的措施。
API 接口 设计文档 模板
Dream调试工具DLL接口文档 文件状态：[√] 草稿[ ] 正式发布[ ] 正在修改当前版本： 1.0 作者：ChunFeng Li 文件密级：[ ]普通[√]秘密[ ]绝密 文档版本 版本/状态作者参与者日期说明 1.0 ChunFeng Li ChunFeng Li 2016-04-13 设备只能发现串口连接的设备，指 令只能下发单条修改 一、DLL初始化 1.描述 调用所有接口之前需要先调用初始化接口。 2.接口名（dll导出名） Dream_Init() 3.请求参数说明 参数字段必选类型限制说明 _net_point True int<65535 Udp广播端口号 _com_rate True int 38400 连接串口的默认波特率 _call_back True Void* ... 异步消息回调（详细见第五条：回调函数） 4.返回参数说明 a.返回类型Int :0成功-1重复初始化 二、获取最新设备列表 1.描述 调用该接口获取所有当前在线列表。 2.接口名（dll导出名） Dream_GetDeviceList() 3.请求参数说明
char_buf True char* 1024 存放返回数据的内存指针，空间大小有调 用方分配 buf_len True int 1024 分配的空间大小 4.返回参数说明 a.返回类型Int : 返回数据长度。 b.返回数据结构:”1000,COM3\r\n1001,COM5\r\n1002,192.168.0.118\r\n”。 [ID,Name\r\n]为一个设备，以后有跟多设备详细信息，往后接。 三、发送指令消息 1.描述 下发数据和读取数据指令都通过该接口实现。(阻塞方式调用函数) 2.接口名（dll导出名） Dream_SendAction() 3.请求参数说明 参数字段必选类型限制说明 device_id True int>1000 发送消息的设备ID例如1000 _ChannelCode True int 0-0xFF 通道编码：例如0x10 _FunctionCode True int 0-0xFF 功能编码，不同的编码对应不同的功能_FunctionNumber True int 0-0xFF 功能编号，标记当前编码对应不同的功能data_msg True char* 发送指令的data，没有数据为NULL，如 果是单个数据：12.1，如果是整组数据： 12.1,1,0,...... 按顺序逗号隔开的连续字符 time_out True int 20*N 接口调用超时时间，单位毫秒 out_buf True char* 存放返回数据的内存指针，空间大小有调 用方分配 buf_max_len True int 分配的空间大小 4.返回参数说明 a.返回类型Int : 返回数据长度。如果为0,表示超时或网络异常 b.返回的数据结构：如果是下发数据，返回的是成功和失 败；”ACK”,”NAK”,”NO_CMD”,”ERROR”,”TimeOut”,如果是读取数据，返回的是数据， 例如12.1，或数据组12.1,12.2,1,1.2..... 四、DLL初始化 1.描述 下发数据和读取数据指令都通过该接口实现。(非阻塞方式调用函数) 2.接口名（dll导出名） Dream_SendAction() 3.请求参数说明
电子面单打印机使用方法
电子面单打印机使用方法 电子面单，亦可称为热敏纸快递标签、经济型面单，二维码面单等，指的是根据物流公司的规定要求，在不干胶热敏纸上打印客户收发件信息的面单。 电子面单在国外已经成功应用多年，如联邦快递(FedEx)和国际快递(Ups)。而在国内，随着电商平台的迅速崛起，快递物流行业也进入飞速发展时期，电子面单的高效率、低错误率更是使得京东、当当、易迅、一号店等电商平台自建立初期就采用了电子面单，与此同时，作为专业打印电子面单的硬件设备，电子面单打印机应运而生。 电子面单打印机，打印速度快，平均每单打印时间为1-2秒钟，操作简单，软件智能，能够高质高效完成打印任务，提升发货效率，提高网购客户满意度。那么电子面单打印机如何使用呢？下面小编就以博思得iQ100电子面单打印机为例来讲解电子面单打印机的使用方法： 一、安装电子面单 01/ 打开打印机右盖，露出纸卷仓，抬起打印头压臂。
02/ 电子面单依次从打印机背部穿纸口和纸导向杆下方穿过; 03/ 将首张面单的前边缘与撕纸标尺的边缘对齐，纸张导向片靠紧面单，但不能过于挤压使面单变形。 04/ 压下打印头压臂，面单安装完成。
二、连接打印机 iQ100电子面单打印机标配USB 2.0 接口，使用USB连接线将打印机连接到电脑，并接通打印机电源。 三、编辑标签模版 iQ100电子面单打印机随机附送一套功能强大的BarTender标签编辑软件。软件界面简单，操作方便。通过查阅软件说明书可编辑标签模版。
同时，iQ100面单打印机兼容市面上各类第三方面单打印机软件，通过任何一款准备使用或正在使用的面单打印软件，即可自动导入收/发货方的信息，自适应电子面单标签模板，实现自动、高效、准确的面单打印。 四、常见故障解决方法 01/ 开机后，打印机操作面板上2个LED灯都不亮 请检查打印机电源是否连接好，电源适配器上指示灯是否常亮。 02/ 安装好标签编辑软件，但无法打开 Windows打印机驱动程序未安装或安装错误，请重新安装打印机驱动程序。 03/ 点击“打印”后，Windows任务栏提示“错误-该文档未能打印” 检查数据连接线是否连接好，标签软件型号是否选择正确。 04/ 打印过程中，标签纸传输正常，但标签纸上无打印内容 检查标签格式设置是否正确，电源是否为原装。 05/ 打印过程中，标签纸传输正常，但打印内容不清晰 在打印软件中调高打印深度：点击文件菜单下的“打印”→“属性”→“选项”→“深度”，然后将深度值调高 06/ 点击“打印”后，打印机“就绪”灯和“纸张”灯同时闪烁 检查纸张探测器位置是否正确，确认位置后校准纸张探测器
免费快递查询接口文档
免费快递查询接口文档-快递鸟API 1.报文及报文编码 接口提供：快递鸟 报文格式：Json 格式 请求方法的编码格式(utf-8)："application/x-www-form-urlencoded;charset=utf-8" 交互协议上统一用UTF-8，避免传递中文数据出现乱码。 2.应用场景 （1）电商网站用户打开“我的订单”时调用此API显示物流信息详情。 （2）电商管理后台的物流系统，客服在对账前查询所有运单的签收状态，并追踪问题。（3）每日调用次数限制不超过3000次，如超过该限制，可对接物流跟踪API。 （4）全流程的物流状态跟踪I 3.关于签名 采用IP 认证加签名 的方式对接，具体方案如下： 1)防止数据被篡改 在POST 请求中会传递 5 个必须(R)参数 RequestData==数据内容(URL 编码:UTF-8) EBusinessID==用户ID RequestType=请求指令类型 DataSign== 数据内容签名：把(请求内容(未编码)+ApiKey)进行MD5 加密，然后Base64编码，最后进行URL(utf-8)编码DataType==返回数据类型(2-json) 注： DataSign 生成后，对方接收到数据后，以同样的算法进行签名，生成摘要，对比两者的摘要是否相同，如果不同，说明传递过程中发生数据篡改。 2)调用接口的身份认证 注册成为接口用户后，会生成对应的用户ID 和APIKey，用户ID 相当于用户名，APIKey 相当于密码。
4.接入步骤 1)接口网注册账号成为用户; 提供的用户ID 是调用接口服务的身份证明，不可更改、不可转用，API Key 是应用访问API 的签名附加密钥，必须妥善保存。两者关系类似于用户名和密码，两者都会在签名和业务参数中使用。 2)登陆用户后台，登陆用户后台，进行实名认证，并开通会员服务; 3)根据技术文档进行开发并在调试平台测试联调；根据技术文档进行开发并在调试平台测试联调； API 接口的DEMO(包括：.Net 版本、Java 版本、PHP 版本)供开发参考。 4)系统发布上线。系统发布上线。 注意：测试环境中获取的测试快递单号不可用于实际发货。 5.Demo 1）.NET开发 using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Web; using https://www.360docs.net/doc/5912164852.html,; using System.IO; namespace KdGoldAPI { public class KdApiSearchDemo { //电商ID private string EBusinessID = "1237100"; //电商加密私钥，注意保管，不要泄漏 private string AppKey = "518a73d8-1f7f-441a-b644-33e77b49d846"; //请求url private string ReqURL = "https://www.360docs.net/doc/5912164852.html,/Ebusiness/EbusinessOrderHandle.aspx"; ///
软件详细设计文档模板(最全面)
研发生产中心文档编号版本A1 密级商密A 项目名称Xx系统 项目来源 Xxx系统 详细设计说明书 (内部资料请勿外传) 编写：日期：检查：日期：审核：日期：批准：日期： XX公司 版权所有不得复制 文档变更记录
序号变更（+/-）说明作者版本号日期批准1 2
目录 1. 引言 (5) 1.1 编写目的和范围 (5) 1.2 术语表 (5) 1.3 参考资料 (5) 1.4 使用的文字处理和绘图工具 (5) 2. 全局数据结构说明 (7) 2.1 常量 (7) 2.2 变量 (8) 2.3 数据结构 (8) 3. 模块设计 (9) 3.1 用例图 (9) 3.2 功能设计说明 (10) 3.2.1 模块1 (10) 3.2.2 模块2 (11) 4. 接口设计 (12) 4.1 内部接口 (12) 4.2 外部接口 (12) 4.2.1 接口说明 (12) 4.2.2 调用方式 (12) 5. 数据库设计 (12) 6. 系统安全保密设计 (12) 6.1 说明 (12) 6.2 设计 (12) 6.2.1 数据传输部分 (12) 6.2.2 IP过滤分部 (13) 6.2.3 身份验证部分 (13) 7. 系统性能设计 (13) 8. 系统出错处理 (13)
1.引言 1.1背景 此文档的背景 1.2编写目的和范围 说明写这份详细设计说明书的目的。 本详细设计说明书编写的目的是说明程序模块的设计考虑，包括程序描述、输入/输出、算法和流程逻辑等，为软件编程和系统维护提供基础。本说明书的预期读者为系统设计人员、软件开发人员、软件测试人员和项目评审人员。 1.3术语表 定义系统或产品中涉及的重要术语，为读者在阅读文档时提供必要的参考信息。 序号术语或缩略语说明性定义 1 PM Project Manager,项目经理 2 1.4参考资料 列出有关资料的名称、作者、文件编号或版本等。参考资料包括： a．需求说明书、架构设计说明书等； b．本项目的其他已发表的文件； c．引用文件、资料、软件开发标准等。 资料名称作者文件编号、版本资料存放地点 1.5使用的文字处理和绘图工具 文字处理软件：[编写设计文档使用的文字处理软件，如RedOffice ] 绘图工具：[使用的UML工具，如Rose、Jude、Visio]
单号自动识别接口文档-快递鸟
单号自动识别接口文档-快递鸟 一.接口说明 PC端、移动端应用或网站应用集成运单物流信息查询功能时，只需要录入单号即可完成查询，无需用户输入快递公司。 电商网站要在快递鸟查询或者订阅运单时，可通过单号识别先行判断物流公司后，再订阅到快递鸟。 二.对接描述 1.该接口仅对运单号做出识别，识别可能属于的一家或多家快递公司。 2.接口并不返回物流轨迹，用户可结合即时查询接口和订阅查询接口完成轨迹查询、订阅的动作。 3.接口识别会返回一家或者多家快递公司，返回的数据根据快递鸟大数据分析结果排序，排名靠前的命中率更高。 4.若识别失败，快递鸟返回的匹配结果为空。 5.接口支持的消息接收方式为HTTP POST，请求方法的编码格式(utf-8)："application/x-www-form-urlencoded;charset=utf-8"。 三.参数列表
四.对接案例 1.JSON请求 { "LogisticCode": "3967950525457" } 2.JSON返回 { "EBusinessID": "1257021", "Success": true, "LogisticCode": "3967950525457", "Shippers": [ { "ShipperCode": "YD", "ShipperName": "韵达快递" } ] } 3.C#对接demo using System; using System.Collections.Generic; using System.IO; using System.Linq; using https://www.360docs.net/doc/5912164852.html,; using System.Text; using System.Web;
(完整word)软件项目文档全套模板-需求说明,推荐文档
＜项目名称＞ 软件需求说明书 作者： 完成日期： 签收人： 签收日期： 修改情况记录：
目录 1 引言 (1) 1.1 编写目的 (1) 1.2 范围 (1) 1.3 定义 (1) 1.4 参考资料 (1) 2 项目概述 (2) 2.1 产品描述 (2) 2.2 产品功能 (2) 2.3 用户特点 (2) 2.4 一般约束 (2) 2.5 假设和依据 (3) 3 具体需求 (3) 3.1 功能需求 (3) 3.1.1 功能需求1 (3) 3.1.2 功能需求2 (4) 3.1.n 功能需求n (5) 3.2 外部接口需求 (5) 3.2.1 用户接口 (5) 3.2.2 硬件接口 (5) 3.2.3 软件接口 (5) 3.2.4 通信接口 (6) 3.3 性能需求 (6) 3.4 设计约束 (6) 3.4.1 其他标准的约束 (6) 3.4.2 硬件的限制 (7) 3.5 属性 (7) 3.5.1 可用性 (7) 3.5.2 安全性 (7) 3.5.3 可维护性 (7) 3.5.4 可转移＼转换性 (8) 3.5.5 警告 (8) 3.6 其他需求 (8) 3.6.1 数据库 (8) 3.6.2 操作 (8) 3.6.3 场合适应性需求 (9) 4 附录 (9)
1 引言 1.1 编写目的 说明编写这份软件需求说明书的目的，指出预期的读者范围。 1.2 范围 说明： a．待开发的软件系统的名称； b．说明软件将干什么，如果需要的话，还要说明软件产品不干什么； c．描述所说明的软件的应用。应当： 1）尽可能精确地描述所有相关的利益、目的、以及最终目标。 2）如果有一个较高层次的说明存在，则应该使其和高层次说明中的类似的陈述相一致（例如，系统的需求规格说明）。 1.3 定义 列出本文件中用到的专门术语的定义和缩写词的原词组。 1.4 参考资料 列出要用到的参考资料，如： a．本项目的经核准的计划任务书或合同、上级机关的批文； b．属于本项目的其他已发表的文件； c．本文件中各处引用的文件、资料，包括所要用到的软件开发标准。 列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。
京东API接口整理
1、类目API 获取商家类目信息 获取类目属性 通过类目属性ID获取属性值列表 设置商家级别的类目销售属性值 添加商家商品销售属性 更新商家商品销售属性 获取类目属性列表 获取类目属性值 获取单个类目信息 查找子类目列表 查询商家已授权的品牌 数据结构 item_cat categoryAttr类目属性对象 attrFeature类目属性特殊属性 categoryAttrGroup属性分组 attrGroupFeature属性分组特殊属性 categoryAttrValue类目属性值对象 attrValueFeature类目属性特殊属性 feature特殊属性 wareaddvender_sellsku添加商家商品销售属性
wareupdatevender_sellsku更新商家商品销售属性 brandList商家品牌List集合 2、店铺API 京东店铺API，包含提供商家、商家店铺基本信息及店内分类操作查询等功能。 添加卖家自定义店内分类 更新商家自定义店内分类 删除商家自定义店内分类 获取前台展示的商家自定义店内分类 查询商家基本信息 店铺信息查询 查询退货地址列表 查询发货地址列表 3、商品API 提供网站商品信息更新、查询API,该组下所有接口均不支持自营店铺业务 1. 新增商品 修改商品 商品上架 商品下架 删除商品信息 根据商品ID查询单个商品的详细信息 批量获取商品信息 检索商品信息
获取商品上架的商品信息 获取商品下架的商品信息 根据商品Id，销售属性值Id查询图片根据商品Id，销售属性值Id增加图片根据商品Id，销售属性值Id删除图片根据商品Id，销售属性值Id设置图片根据商品Id，检索商品图片 设置商品限购区域 查询商品限购区域 添加商品关联版式 修改商品关联版式 删除商品关联版式 查询关联版式id以及名称 查询关联版式详情 设置关联版式到商品 增加SKU信息 修改SKU信息 修改SKU库存信息 修改SKU价格信息 删除SKU 信息 根据外部ID获取商品SKU 根据商品ID列表获取商品SKU信息 获取单个SKU信息 回复商品评价 查询商品评价信息列表
快递鸟API电子面单接口参数配置对照表
备注： 调用电子面单时IsNotice参数可控制是否通知快递员上门揽件（*0-通知；1-不通知；不填则默认为0）表中帐号和密码指的是向快递公司网点申请开通电子面单权限后，快递公司提供的电子面单帐号和密码申通电子面单不支持测试环境，只能在正式环境下使用
中通电子面单账号开通流程
圆通电子面单账号开通流程
快递鸟电子面单接口常见问题 问题：什么是电子面单？相比传统面单而言它有什么优势？ 电子面单是一种新型的快递面单。材料为热敏纸，有成本低、打印快、单号方便获取、管理等特点。在行业内也被称为热敏纸快递标签、经济型面单，二维码面单等。它与传统面单相比主要有如下区别和优势。 a. 效率更高 n 提升打印效率：电子面单的打印效率是普通纸质面单的4-6倍，平均每单打印只需花费1-2秒钟，高效率的打单大大缓解电商等客户的大批量打单压力，轻松应对大促； n 提高发货效率：电子面单不需要把快递单和定单信息逐一匹配操作，在订单信息申请快递单号的时候就已完成了定单匹配；卖家无需再安排人员专门抽取“发货联”，操作效率进一步提升；减少了手写“大头笔”等动作，提高了分拣效率；提高了分拣的准确性； n 支持多种电商增值业务，无需人肉绑定面单（例如：货到付款，预约配送）。 b. 成本更低 n 电子面单的纸张是0.1元/张，成本比传统纸质面单0.2-0.3元降低了一大半； n 降低快递公司作业成本，如取消抽单和手写大头笔，单位时间内的揽货可以提升一倍以上； c. 数据信息完整实效 n 在申请电子面单运单号的时候，就匹配到具体的“大头笔”信息，既减少人工操作的成本并又可以提高准确率和效率； 商家在使用电子面单的时候就会自动将数据同步给快递公司，可以在申请面单的时候就拿到第一手数据，更加真实并且提高速度。 问题：快递鸟电子面单接口如何对接？ 1、注册快递鸟APIkey https://www.360docs.net/doc/5912164852.html,/reg 2、加技术问题交流群：200121393 在群文件中下载技术接口文档 3、请贵司技术根据技术文档开发后测试（需快递网点账号） 4、上线 问题：各快递公司编码是什么？电子面单账号如何开通？需要提供什么？ 顺丰（SF）百世快递（HTKY）百世快运（BTWL）申通（STO）中通（ZTO）圆通（YTO）韵达（YD）EMS（EMS）宅急送（ZJS）德邦（DBL）全峰（QFKD）如风达（RFD）优速快递（UC）龙邦（LB）增益（ZENY）华航快递（HHKD）运通快递（YTKD）希优特（XYT）民邦物流（MB）长沙创一（CSCY）安能物流（ANE）精英速运（JYSY） 问题：快递鸟电子面单接口返回的html模板包含什么内容呢?打印出来的实际效果是什么样的？针对每个快递公司，模版都会有变化嘛还是采用统一的模版样式？ 返回的是快递公司官方认可的html模板，电子面单接口会返回包含收件人和寄件人以及商
api接口文档
API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件的以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。API除了有应用“应用程序接口”的意思外，还特指API的说明文档，也称为帮助文档。 API：应用程序接口（API：Application Program Interface） 应用程序接口（是一组定义、程序及协议的集合，通过API 接口实现计算机软件之间的相互通信。API 的一个主要功能是提供通用功能集。程序员通过调用API 函数对应用程序进行开发，可以减轻编程任务。API 同时也是一种中间件，为各种不同平台提供数据共享。 根据单个或分布式平台上不同软件应用程序间的数据共享性能，可以将API 分为四种类型： 远程过程调用（RPC）：通过作用在共享数据缓存器上的过程（或任务）实现程序间的通信。 标准查询语言（SQL）：是标准的访问数据的查询语言，通过数据库实现应用程序间的数据共享。 文件传输：文件传输通过发送格式化文件实现应用程序间数据共享。
信息交付：指松耦合或紧耦合应用程序间的小型格式化信息，通过程序间的直接通信实现数据共享。 当前应用于API 的标准包括ANSI 标准SQL API。另外还有一些应用于其它类型的标准尚在制定之中。API 可以应用于所有计算机平台和操作系统。这些API 以不同的格式连接数据（如共享数据缓存器、数据库结构、文件框架）。每种数据格式要求以不同的数据命令和参数实现正确的数据通信，但同时也会产生不同类型的错误。因此，除了具备执行数据共享任务所需的知识以外，这些类型的API 还必须解决很多网络参数问题和可能的差错条件，即每个应用程序都必须清楚自身是否有强大的性能支持程序间通信。相反由于这种API 只处理一种信息格式，所以该情形下的信息交付API 只提供较小的命令、网络参数以及差错条件子集。正因为如此，交付API 方式大大降低了系统复杂性，所以当应用程序需要通过多个平台实现数据共享时，采用信息交付API 类型是比较理想的选择。 API 与图形用户接口（GUI）或命令接口有着鲜明的差别：API 接口属于一种操作系统或程序接口，而后两者都属于直接用户接口。 有时公司会将API 作为其公共开放系统。也就是说，公司制定自己的系统接口标准，当需要执行系统整合、自定义和程序应用等操作时，公司所有成员都可以通过该接口标准调用源代码，该接口标准被称之为开放式API。
快递鸟快递查询接口API代码
快递鸟快递查询接口API代码 1.代码使用说明 （1）查询接口支持按照运单号查询(单个查询)。 （2）接口需要指定快递单号的快递公司编码，格式不对或则编码错误都会返失败的信息。（3）返回的物流跟踪信息按照发生的时间升序排列。 （4）接口指令1002。 （5）接口支持的消息接收方式为HTTP POST，请求方法的编码格式(utf-8)："application/x-www-form-urlencoded;charset=utf-8"。 （6）接口提供：快递鸟 2.功能展现 （1）电商网站用户打开“我的订单”时调用此API显示物流信息详情。 （2）电商管理后台的物流系统，客服在对账前查询所有运单的签收状态，并追踪问题。（3）每日调用次数限制不超过3000次，如超过该限制，可对接物流跟踪API。 （4）全流程的物流状态跟踪I 3.代码签名 采用IP 认证加签名 的方式对接，具体方案如下： 1)防止数据被篡改 在POST 请求中会传递 5 个必须(R)参数 RequestData==数据内容(URL 编码:UTF-8) EBusinessID==用户ID RequestType=请求指令类型 DataSign== 数据内容签名：把(请求内容(未编码)+ApiKey)进行MD5 加密，然后Base64编码，最后进行URL(utf-8)编码DataType==返回数据类型(2-json) 注： DataSign 生成后，对方接收到数据后，以同样的算法进行签名，生成摘要，对比两者的摘要是否相同，如果不同，说明传递过程中发生数据篡改。 2)调用接口的身份认证 注册成为接口用户后，会生成对应的用户ID 和APIKey，用户ID 相当于用户名，APIKey 相当于密码。 4.接口申请 1)接口网注册账号成为用户; 提供的用户ID 是调用接口服务的身份证明，不可更改、不可转用，API Key 是应用访问API 的签名附加密钥，必须妥善保存。两者关系类似于用户名和密码，两者都会在签名和业务参数中使用。 2)登陆用户后台，登陆用户后台，进行实名认证，并开通会员服务; 3)根据技术文档进行开发并在调试平台测试联调；根据技术文档进行开发并在调试平台测试联调； API 接口的DEMO(包括：.Net 版本、Java 版本、PHP 版本)供开发参考。 4)系统发布上线。系统发布上线。
软件开发文档模板库
软件开发文档模板库 1 可行性研究报告 可行性研究报告的编写目的是：说明该软件开发项目的实现在技术、经济和社会条件方面的可行性；评述为了合理地达到开发目标而可能先择的各种方案；说明论证所选定的方案。 可行性研究报告的编写内容要求如下： 1.1 引言 1.1.1 编写目的 1.1.2 背景 1.1.3 定义 1.1.4 参考资料 1.2 可行性研究的前提 1.2.1 要求 1.2.2 目标 1.2.3 条件、假定和限制 1.2.4 进行可行性研究的方法 1.2.5 评价尺度 1.3 对现有系统的分析 1.3.1 数据流程和处理流程 1.3.2 工作负荷 1.3.3 费用开支 1.3.4 人员 1.3.5 设备 1.3.6 局限性 1.4 所建议的系统 1.4.1 对所建议系统的说明 1.4.2 数据流程各处理流程 1.4.3 改进之处 1.4.4 影响 1.4.4.1 对象设备的影响 1.4.4.2 对软件的影响 1.4.4.3 对用户单位机构的影响 1.4.4.4 对系统动行的影响 1.4.4.5 对开发的影响 1.4.4.6 对地点和设施的影响 1.4.4.7 对经费开支的影响 1.4.5 局限性 1.4.6 技术条件方面的可行性 1.5 可选择其他系统方案 1.5.1 可选择的系统方案1
1.5.2 可选择的系统方案2 …… 1.6 投资及收益分析 1.6.1 支出 1.6.1.1 基本建设投资 1.6.1.2 其他一次性支出 1.6.1.3 非一次性支出 1.6.2 收益 1.6. 2.1 一次性收益 1.6. 2.2 非一次性收益 1.6. 2.3 不可定量的收益 1.6.3 收益/投资比 1.6.4 投资回收周期 1.6.5 敏感性分析 1.7 社会条件方面的可行性 1.7.1 法律方面的可行性 1.7.2 使用方面的可行性 1.8 结论 2 项目开发计划 编制项目开发计划的目的是用文件的形式，把对于在开发过程中各项工作的负责人员、开发进度所需经费预算、所需软、硬件条件等问题作出安排记载下来，以便根据本计划开展和检查本项目的开发工作。编制内容要求如下： 2.1 引言 2.1.1 编写目的 2.1.2 背景 2.1.3 定义 2.1.4 参考资料 2.2 项目概述 2.2.1 工作内容 2.2.2 主要参加人员 2.2.3 产品及成果 2.2. 3.1 程序 2.2. 3.2 文件 2.2. 3.3 服务 2.2. 3.4 非移交产品 2.2.4 验收标准 2.2.5 完成项目的最迟期限 2.2.6 本计划的审查者与批准者 2.3 实施总计划 2.3.1 工作任务的分解 2.3.2 接口人员 2.3.3 进度 2.3.4 预算 2.3.5 关键问题
开发接口API模板
XXX项目接口文档 版本控制信息 1获取所有字段 1.1获取所有字段 请求地址：/session/field/findAll 请求参数 响应 响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统处理正常！","page":0,"pageSize":0,"returnObject":null,"returnValue":{"types":null,"villages":null,"companys":[{"iconColour":"",
"iconSize":0,"iconStyle":"","id":4,"name":"XX"},{"iconColour":"","iconSize":0,"iconStyle":"","id":5,"name":"XX"},{"icon Colour":"","iconSize":0,"iconStyle":"","id":7,"name":"XX"}]},"totals":0} 2文件上传 2.1文件上传（ajax） 请求地址：/session/file/upload 请求参数 响应 请求例子：var formData = new FormData(); formData.append("file", this.files[0]); $.ajax({ url : routePath + "/session/file/upload", type : 'POST', data : formData, processData : false, contentType : false, success : function(result) { result = JSON.parse(result); if(result.code == "10000"){