开放的接口

2 不同场景下的接口使用建议

• 2.1 商家不使用自定义区
• 2.2 商家基本都使用预设的自定义区
• 2.3 商家对自定义区有特殊需求

3 TOP API 对接

4 沙箱环境的对接（重要）

利用TOP接口，可以获取菜鸟电子面单标准模板，结合电子面单取号数据可以通过菜鸟打印组件进行面单打印

1 开放的接口

目前开放的TOP接口包括：

模板获取相关接口

• 电子面单取号接口
  请参考：//open.alitrip.com/docs/doc.htm.htm?spm=a219a.7629140.0.0.AOUR3v&treeId=17&articleId=104859&docType=1

2 不同场景下的接口使用建议

为了更快速的接入，我们整理了一些常见的使用情形供isv接入时参考。

2.1 商家不使用自定义区

• 这种情况的接入最简单，但也最少。
• 对isv来讲，只需调用cainiao.cloudprint.stdtemplates.get获取标准模板信息，然后取电子面单号即可。
• 对商家商家来讲，不需要额外菜鸟模板编辑器去选择使用的模板。

2.2 商家基本都使用预设的自定义区

• 在这种场景下，很多商家需要使用自定义区，但对自定义区的内容几乎很少变动，这种接入方式也比较简单。
• 对isv来讲：可以在模板编辑器中预设好几个自定义区（不是打印项）,然后调用接口获得之后（依次调用:xxxxx），展示在ERP系统中，给商家使用即可；
• 商家此时也可不用登陆菜鸟模板编辑器去选择使用的模板，可以减少商家的工作量。

2.3 商家对自定义区有特殊需求

客户(商家)对待自定义区的特殊需求有很多，随意组合很多打印项，还有的要求能循环打印内容（比如买家的商品列表），通过isv预设自定义区无法覆盖这部分高级需求。
对isv来说，不再需要预设自定义区，而是提供各个有独立功能打印项即可，商家可以自由组合；(这种情况依次调用接口：xxxxx)
对商家来说：需要登录菜鸟模板编辑器选择使用的模板，在模板上创建自定义区，选择要搭配的打印项。
isv可以提供带有循环功能的打印项，在模板编辑中打开代码模式。一个示例为：提供“商品列表”这么一个打印项，商家选择这个打印项之后就会循环输出所有商品名，则打印项的示例代码如下：

<%
  for(var i=0;i<_data.goods.length;i++){   
%>
    <text
      value="<%=_data.goods[i].name%>"
      editor:_printName_="请输入内容"
      style="fontFamily:宋体;"
    />
<%}%>

3 TOP API 对接

详细文档参考

4 沙箱环境的对接（重要）

如果条件允许，尽量直接使用线上环境的接口，如果使用的是沙箱环境，那么就需要按照如下配置进行修改。

在开放平台的接口说明中，沙箱环境的http请求地址一般是使用http://gw.api.tbsandbox.com/router/rest，对于其他的接口来说这是没问题的。但对于菜鸟打印组件所开放的top接口来说，是有问题的。这是因为我们开放的top接口返回结果中包含模板的url，在正常的沙箱环境中，我们域名会被重写为http://cloudprint.tbsandbox.com开头，但这个域名无法通过电子面单的校验。

请按如下方式进行环境的配置，同时需要注意的是，下面的这些修改仅仅是针对沙箱环境调试阶段，线上无需做任何更改：

4.1 更改沙箱环境的http请求地址

原有的沙箱http请求为http://gw.api.tbsandbox.com/router/rest.请将其改为： http://proxy.api.tbsandbox.com/router/rest

4.2 绑定hosts文件

42.156.238.99 cloudprint.daily.taobao.net

2017 cainiao.com 版权所有。菜鸟网络保留修改权利。