一、引言
1.1 概述
(1)该白皮书主要描述的是ISV/自研ERP使用菜鸟电子面单的方案,适用该方案的ISV/自研ERP具备如下几个特点:
①ISV/自研ERP有对接菜鸟电子面单的需求;
②ISV/自研ERP无需从淘宝开放平台拉取订单。(link仅支持明文取号)
备注:若ISV/自研ERP需从淘宝开放平台拉取订单,请通过淘宝开放平台对接:https://open.taobao.com/doc.htm?docId=119471&docType=1#4;
(2)该方案为三方授权方案,需要注册一个ISV账号申请API并发布,然后重新注册一个商家账号对该ISV发布的应用进行授权,方可完成对接。
1.2 名词解释
用户角色 |
用户描述 |
LINK |
Logistics Integration Network,物流集成网络 |
CP |
Cainiao Partner 菜鸟合作伙伴 |
CN |
菜鸟 |
ISV |
Independent Software Vendors,独立软件开发商 |
物流云平台 |
|
物流云平台授权地址 |
|
电子面单管理中心 |
https://miandan.cainiao.com/login.htm?userType=cainiao#/ 菜鸟账号订购入口 https://miandan.cainiao.com/login.htm?userType=taobao#/ 淘宝账号订购入口 |
二、详细功能说明
1 ISV端入驻
1.1 主体流程
1.2 注册菜鸟账号
(1)登录菜鸟开放平台—客户控制台
打开https://open.cainiao.com/点击右上角的【客户控制台】。
登录可以使用淘宝账号或者菜鸟账号,如果没有账号可以点击下方【免费注册】创建账号。
注意:最好是企业账号注册,个人账号注册,后续人员变动不好交接
填写信息,完成企业账号注册并且登录菜鸟开放平台(注册过程中遇到问题,点击页面右侧机器人按钮进行咨询)
1.3 新建应用
(1)新建应用,在应用管理内点击“新建应用”
业务类型选择:快递数字化
资质类型选择:第三方isv资质
【应用名称】请根据自身产品名称填写便于识别,如XXX电商平台,XXX工具。然后点击右下方“创建”。
【回调地址】该域名用于三方授权交互,使用商家授权中的集中授权方式。(示例:https://cainiao.com),后续更改域名可参考1.6步骤
1.4 isv资质认证
若提示资质认证申请,则需按照提示,上传公司营业执照、开户许可等,进行ISV认证入驻审核。
审核完成后进行【编辑应用】-【绑定API】。若已经申请,请直接进入1.5步骤进行绑定API。
公司名称请提供到钉钉群人工支持,直接发出来公司名称,不要截图,确认资料无误,请等待审核,一般当天会审核通过,扫码入群:
1.5 API配置
(1)配置绑定API
点击【点击跳转】进入页面配置API,再点击绑定API
(2)选择电子面单API
选择场景:电子面单对接统一接口,一共10个接口都进行打勾,点击确认
(3) 资源code配置
进入【资源code配置】页面,请直接点击下一步,注意需要等app key创建完成后才可授权。检查所添加的API是否正确,不正确可点击【上一步】返回修改,确定无误后点击【正式提交】
(4)审核API
若需要审核则点击【刷新进度】,刷新后会自动审核通过
1.6 服务器域名配置
链接:https://cloud.cainiao.com/permission/index
在菜鸟开放平台新建应用时填写的回调地址(1.3步骤-回调地址),在物流云工作台打开ISV服务器地址时会显示顶级域名格式不正确,需要修改为符合要求的顶级域名格式后保存。可点击【订阅API】-【isv服务器地址】进行修改地址保存
1.7 测试联调
API发布完成后,请参照1.8中的代码示例进行联调测试。
1.8 API对接
1.8.1 物流云SDK下载
1.8.2 API列表
备注:首先调用订购关系查询接口获取发货地址,再用查到的发货地址调用取号接口来获取单号
1.9 代码示例
使用SDK的代码示例:
不使用SDK的代码示例:
C#语言签名示例:
1.10 打印面单
可使用菜鸟云打印组件进行打印。
(1)客户端下载链接。https://support-cnkuaidi.taobao.com/doc.htm#?docId=108934&docType=1
(2)云打印接入说明文档链接(可参考其中的物流云对接章节)。https://support-cnkuaidi.taobao.com/doc.htm#?docId=108595&docType=1
(3)主流快递公司模板列表。请对接https://support-cnkuaidi.taobao.com/doc.htm#?docId=108594&docType=1的CLOUDPRINT_STANDARD_TEMPLATES接口
2 商家授权
商家授权存在两种方式,ISV可选择商家手动授权,同时也可选择集成授权方式。
商家账号类型:淘宝账号、菜鸟账号;
商家账号要求:必须是主账号,不支持子账号授权。
2.1 商家手动授权
2.1.1 注册商家账号
(1)在电子面单管理中心注册菜鸟账号或者淘宝账号,注册账号链接https://miandan.cainiao.com/login.htm?userType=cainiao#/
备注:若您是一个ISV,同时也是一个商家身份,请先注册商家账号,不能使用在物流云注册的ISV账号进行登录。
(2)注册菜鸟或淘宝账号。淘宝账号选择页面下面【淘】进行注册
2.1.2 商家授权(商家账户登录操作)
(1)使用注册的商家菜鸟账号或者淘宝账号登录到物流云平台对ISV进行授权。输入【商家账户昵称密码】,淘宝账号需要额外点击【确认授权】
物流云平台链接(商家账号登录):https://cloud.cainiao./permission/index
(2)查询应用,根据【AppKey】或【应用名称】搜索到对应的应用,若应用未审核通过,则此处搜索不到。
(3)点击【授权】,选择对应的账号身份,点击【确认授权】,完成授权动作
菜鸟账号即选择菜鸟,淘宝账号即选择淘宝账号。
(4)查看授权,复制TOKEN,将TOKEN码给到ISV,路径:【用户中心】-【三方授权管理】-【查看授权】-【复制】。
请一定要点击“复制”按钮哦。
2.1.4 配置授权Token
非常重要!!
(1)在系统中存储商家授权Token,在获取运单号时传给菜鸟,以便能够解析出商家与ISV之间的绑定关系;
(2)获取方式:商家在物流云系统中对ISV进行授权后,商家可复制Token给到ISV。
(3)备注:Token的有效期为一年,Token到期后需商家对ISV进行重新授权。
2.2 集成授权方式
3 商家申请电子面单服务
具体申请流程请看链接:https://page.cainiao.com/waybill/static-pc-new/non-tb-subscription-doc.html
4 联系我们
如果有问题,请加钉钉群咨询,钉钉扫码入群:
如没有钉钉,请下载安装。