注意:以下文档只适用于TOP接口,请谨慎使用!

文档中心 > 电子面单对接知识库

菜鸟云打印接入说明

更新时间:2018/09/13 访问次数:41583

本文主要介绍云打印产品,并提供ISV或自研商家开发接入指引。

云打印产品介绍

菜鸟云打印产品提供电商全流程打印(如面单/拣货单/发货单等)所需的解决方案,涵盖了从模板设计、打印内容渲染、多端打印的整个流程,整个产品对外主要分为模板编辑器模板查询服务云打印组件等几块。

云打印模板

云打印模板是一套用于描述打印展示内容和样式的模板文件,其定义了一套标准,包括菜鸟打印标记语言和JavaScript动态代码嵌入规范,模板是串起整个菜鸟云打印链路的核心。云打印组件通过将数据与模板进行结合,产出静态数据文件,并渲染后驱动打印机完成打印动作。

云打印标记语言链接

模板分类:

  • 标准模板 - 由菜鸟官方维护的电子面单标准模板
  • 自定义模板 - 商家或ISV自定义的其他模板,如拣货单、发货单等
  • 自定义区 - 模板中可设置自定义区,供服务的订购方自定义打印内容。如标准模板里的自定义区,如可供商家打印发货的商品信息
  • 打印项 - 将多个打印元素提取成打印项,可供拖放到自定义区使用。如ISV创建了“商品数量+宝贝简称+销售属性”的打印项,商家直接可将其放置自定义区打印这3条属性

面单示例:
undefined

模板编辑器

模板编辑器为一套Web系统,其提供了可视化、所见即所得的模板设计界面,设计者可以通过此系统完成模板的创建、修改和分类管理,上手简单和友好。

模板编辑器支持淘宝账号菜鸟账号登录:

  • 淘系电商:请使用淘宝账号
  • 非淘电商:推荐使用菜鸟账号
  • ISV和自研商家:请使用入驻淘宝开放平台或物流云的账号登录

  • 商家:请在淘宝服务市场或物流云订购ISV产品后,使用主账号登录管理

模板查询服务

模板查询服务通过淘宝开放平台和菜鸟物流云网关对外提供,通过该服务可获取模板编辑器中维护的模板地址。

模板维护方 模板类型 模板地址说明
菜鸟 菜鸟电子面单标准模板 考虑到陆续会有新的CP接入菜鸟电子面单,以及对于已接入的CP也会有增加模板的需要,为了确保用户端能及时得到新模板的更新,请ISV通过模板查询服务来获取模板地址
ISV 打印项、ISV自定义模板、ISV预设自定义区 ISV可选择自己管理模板地址,也可以通过模板查询服务获取
商家 商家自定义模板、商家自定义区 只能使用模板查询服务获取商家模板地址

淘宝开放平台(TOP)模板查询服务
菜鸟物流云(LINK)模板查询服务

云打印组件

云打印组件是面向Windows平台的一个打印客户端程序,可接收ISV软件发送的打印请求,根据模板地址下载模板,结合请求中的打印数据完成打印内容的渲染,并将请求写入打印机完成打印。

对于ISV软件商接入,需要使用云打印组件交互协议,该协议采用websocket,语言和环境无关性。

云打印组件交互协议

打印交互流程

打印交互流程如图所示:
undefined

流程介绍:

1.商家使用ISV打单软件;
2.ISV打单软件,通过淘宝开放平台(TOP)或菜鸟物流云(LINK)开放的云打印模板查询服务获取模板地址列表,模板包括标准电子面单模板和自定义区模板,电子面单模板供ISV取号及云打印组件打单时使用,商家可选择要使用的自定义模板(具体交互形态请ISV自己决定);
3.ISV打单软件,调用电子面单取号服务,传入收发件人信息、电子面单模板地址等信息,取得面单号及面单打印数据;
4.ISV打单软件,将模板地址和打印数据,通过云打印组件交互协议提交给云打印组件;
5.云打印组件将数据渲染后,驱动打印机完成打印;

ISV或自研商家接入流程

打单场景-菜鸟电子面单

1、ISV或自研商家入驻

入驻分为淘宝开放平台菜鸟物流云两种方式,对于做淘系电商的请入驻淘宝开放平台,对于做非淘电商的请选择入驻菜鸟物流云

淘宝开放平台
1) 注册淘宝账户,登陆淘宝开放平台成为开发者
操作请参考:新手指南-入驻成为开发者

2) 进入控制台并创建应用,ISV请选择商家后台系统-仓储管理系统自研商家身份请选择我是天猫/集市商家-商家后台系统
操作请参考:新手指南-申请应用标签

3) 完成上述操作后,将拥有电子面单权限接口权限,即包括电子面单取号、云打印模板查询等接口权限

物流云
1) 注册菜鸟账户,并登陆物流云成为开发者
操作请参考:新手指南-注册账号

2) 创建应用,并订购电子面单产品包
操作请参考:新手指南-业务组件

3) 完成上述操作后,将拥有电子面单产品包中所有接口的权限,即包括电子面单取号、云打印模板查询等接口权限

2、编辑器新增ISV预设自定义区模板(可选)

如只使用三联模板,或不支持二联模板的自定义区,可跳过该步
请使用菜鸟提供的云打印模板编辑器进行模板编辑

3、模板查询服务接入

使用云打印组件时,需要传入模板地址和打印数据,使用菜鸟提供的模板查询服务获取模板地址的好处,是为了在线上模板增删后,ISV打单软件能及时获取到最新的模板地址。
1)在电子面单场景,我们要求所有的电子面单标准模板地址均通过模板查询服务获取。
2)其他场景ISV可根据自身需要,模板地址由自己维护或使用菜鸟提供的模板查询服务来获取。

接入请参考:
淘宝开放平台(TOP)模板查询服务
菜鸟物流云(LINK)模板查询服务

4、云打印组件协议接入

云打印组件是运行在Windows平台上的独立程序进程,其提供本地端口监听,采用WebSocket协议供ISV打单软件调用使用。正是由于采用了WebSocket协议,其具备有打单软件技术架构无关性,以及支持局域网跨机器调用的优势。

接入请参考:
云打印组件交互协议文档

5、便携式打印机对接(可选)

便携式打印机对接,一般用于ISV自研的移动端打单软件,如微信/支付宝小程序、IOS/Android本地应用等,可满足各种使用移动需求打单的场景。

对接请参考:
便携式蓝牙打印机对接

内部联调、测试及发布等

此处不再详述。

打单场景-其他单据

基本流程同上,区别是ISV将使用编辑器新增自定义模板,模板地址管理可以用菜鸟提供的服务获取,也可以ISV自己管理

FAQ

关于此文档暂时还没有FAQ
返回
顶部