步骤一:登陆菜鸟账号
请按照账号登录指引完成账号注册和登陆。
如果您已有菜鸟账号,请忽略此步骤。
步骤二:明确需要的场景
菜鸟开放平台提供多种快速接入场景,您可以在概览页面查看全量场景合集,通过场景接入的应用可快速审核通过。
不同的场景下包含了不同的API合集,提供的服务能力也不同。具体场景下的能力集合请查看:无忧物流场景、国际快递场景
步骤三:快速接入
选择了场景后,点击右下角的快速接入
您需要配置以下信息:
-
应用名称:一般为中英文组成,不含有特殊字符
-
资质类型:
选择你使用该应用访问时需要的资质类型,不同的场景所需的资质条件不同,如果您没有特殊资质类型,可选择普通用户进行测试,如果您有其他身份,请先完成资质认证。
-
配置API信息
场景下已经预置好订阅和注册的API列表,您也可以根据自身需要做响应的筛选,取消掉不需要的API(请事先跟业务对接人确认好所需要的API)。
订阅API:由您来订阅菜鸟提供的API服务,您可以使用所创建的应用身份来完成调用访问。
注册API:您需要将自己的后端服务注册到该API上,将数据或信息通过此API传递给菜鸟。
字段脱敏申请:API涉及到敏感字段信息默认脱敏,如果您需要获取到这些字段的明文,请点击字段脱敏申请提交审核。
修改配置:您可以修改API的编码格式和报文格式;注册API的配置修改,可以设置两个访问地址,其中联调请求地址是您若需正式上线前与菜鸟联调,菜鸟将会调用您的联调请求地址,联调结束后再调用真实请求地址。
-
完成接入
以上操作完成后,系统将自动完成应用创建、订阅API、注册API和验证,通过场景接入的应用可快速审核通过。
步骤四:开始联调
-
应用上线后,点击更多->进入联调,可以进入联调任务管理列表
-
您可以在该列表查看联调所需的所有任务和用例
-
点击任务详情,查看每个任务下的用例执行情况
-
点击执行用例,您可以对该用例做对应的请求下发测试,观察返回结果是否符合预期