严选渠道对接流程-V2.0.7

文档说明

基本说明

本文档用于描述渠道方与严选进行 OpenAPI 对接的具体流程,明确对接过程每一个步骤中的相关责任人、采取的沟通方式、需提供的材料、完成后的状态。

重要说明

本文中涉及的所有邮件往来,请务必严格遵照以下四点!

  • 邮件回复时请务必使用回复全部
  • 发件人、收件人邮箱地址在对接开始时相互进行确认;
  • 收件人请务必添加严选技术的邮箱地址;
  • 主题与内容请采用指定模板格式

对接流程

Step1. 明确接入需求

流程

流程1

  • 渠道方与严选签订合同
  • 严选市场方以邮件形式发起对接,模板如下:

严选市场邮件模板

主 题:【网易严选API对接】XXX渠道对接
发件人:严选市场的邮箱地址
收件人:严选技术的邮箱地址
抄  送:<渠道方抄送邮箱地址>,<严选方抄送邮箱地址>

严选技术:
  严选技术,你们好。XXX渠道现需进行API对接,分销系统已创建相应渠道,请严选技术团队安排相关人员协作完成对接工作。渠道方技术人员:XXX,邮箱:XXX,严选方运营:XXX,邮箱:XXX。
  • 严选产品与技术部接受邮件,确认需求。

Step2. 配置并验证测试环境

流程

流程1

详细说明:

1. 严选技术请求测试环境参数

  • 确认收到市场部的申请邮件
  • 发送邮件至渠道方邮箱,内容如下:
    • 请求渠道方测试环境下的 IP 白名单、统一回调URL
    • 附件:《严选渠道对接流程》、《OpenAPI 接口文档》、《OpenAPI 对接Demo》
  • 邮件格式请严格参照模板:严选技术邮件模板

2. 渠道方回复测试环境参数

  • 渠道方查看《严选渠道对接流程》、《OpenAPI接口文档》
  • 根据严选要求将测试环境下的IP白名单、统一回调URL以邮件的形式回复至严选邮箱
  • 完成后等待严选配置测试环境。
  • 邮件格式请严格参照模板:渠道方回复测试环境参数邮件模板

3.严选技术配置测试环境

  • 配置测试环境

    • 根据渠道方提供参数将渠道信息录入分销系统,完成配置
    • 申请渠道测试IP白名单的外网访问权限,添加测试Sku
  • 发送邮件至渠道方

    • 严选将测试信息以邮件的形式发送至渠道方的邮箱。信息包括:
      • 测试环境中的AppKey及AppSecret、
      • 测试SkuId
      • OpenAPI测试环境URL
  • 邮件格式请严格参照模板: 严选技术配置测试环境参数邮件模板

4. 渠道方接入测试环境☆

渠道方请务必根据《OpenAPI接口文档》、《OpenAPI对接Demo》以及严选提供的测试环境参数进行开发测试。
关于如何接入测试环境,具体内容参考【 附录:渠道接入测试环境

5. 渠道方申请修改测试环境相关配置☆

6. 严选技术回复更新测试环境配置

严选技术修改好渠道方测试环境配置后,以邮件形式告知渠道。严选技术回复模板:严选技术回复更新测试环境配置邮件模板

7. 渠道方完成集成测试☆

渠道方务必通过以下路径完成测试:

  • 渠道查询商品列表——渠道查询商品信息——渠道维护渠道展示信息(库存为0的下架或不可卖)
  • 渠道下单——严选发货(订单绑定)——严选回调订单绑定方法——渠道更新订单信息——渠道确认收货
  • 渠道下单——严选发货——渠道取消订单——取消失败
  • 渠道下单——渠道取消订单——订单取消成功(或失败)
  • 渠道下单——渠道取消订单——严选客服审核——严选回调订单取消方法
  • 渠道下单——严选回调异常方法——渠道更新订单信息

邮件模板

严选技术邮件模板

XXX(渠道名称):
  你们好。我方已收到你方对接申请,《对接流程》、《OpenAPI 对接 Demo》、《常见问题》和《OpenAPI 文档》等内容参见http://open.you.163.com。
  附件为《对接流程》、《渠道自主测试回调文档》、《订单流程》、《售后流程》,敬请查看。我们将根据《对接流程》于你方协作完成 OpenAPI 对接工作。
  现需你方提供一下配置信息:测试环境 IP 白名单,统一回调 URL,这些配置信息将用于配置严选测试环境,以便进行 OpenAPI 对接的开发测试。

渠道方回复测试环境参数邮件模板

严选团队:
     严选团队,你们好。以下是我方测试环境的相关配置:
     测试环境IP白名单:xxx
     测试环境统一回调URL:xxx
     烦请你方尽快完成测试环境的相关配置。

严选技术配置测试环境参数邮件模板

XXX(渠道名称):
     XXX,你们好。我方已完成测试环境配置,测试环境配置如下:
     测试环境IP地址:xxx
     测试环境AppKey:xxx
     测试环境AppSecret:xxx
     请参考《OpenAPI对接Demo》完成API对接的开发测试工作,请在完成之后以邮件的形式申请进行线上环境对接。

渠道方申请修改测试环境参数邮件模板

严选团队:
     严选团队,你们好。现我方申请修改测试环境的相关配置:
     修改参数: IP白名单/统一回调URL
     修改类型:增加/覆盖
     修改内容: xxx
     更新原因:xxx
     烦请你方尽快完成测试环境的相关配置。

严选技术回复更新测试环境配置邮件模板

XXX(渠道):
    XXX(渠道),你们好。我方已更新测试服环境配置。

Step3. 配置并验证线上环境

流程

流程1

详细说明:

邮件模板

渠道方提供线上环境配置参数邮件模板

严选团队:
​     严选团队,你们好。以下是我方线上环境的相关配置:
​     线上环境IP白名单:xxx
​     线上环境统一回调URL:xxx
     对接接口:全部接口(按实际对接情况填写)
     对接回调:全部回调(按实际对接情况填写)
​     烦请你方尽快完成线上环境的相关配置。

严选技术审核失败回复渠道邮件模板

XXX(渠道名称):
​     XX渠道,你们好。
      很抱歉,你方接入严选线上环境的审核失败。
      失败原因如下:

严选技术审核成功告知市场部邮件模板

严选市场:
​     你们好。XXX(渠道方名称)已通过技术审核。请在线上环境中将渠道信息录入分销系统。配置完成后请尽快回复信息。

严选市场配置线上渠道邮件模板

严选运营:
​     严选运营,你们好。渠道信息已录入线上服,请完成线上环境的选品配置。

严选运营配置线上渠道选品邮件模板

严选技术:
​     严选技术,你们好。渠道线上环境的选品配置已完成,请完成线上环境的参数配置。

严选技术配置线上环境参数邮件模板

XXX(渠道名称):
​     XXX,你们好。我方已完成线上环境配置,线上环境配置如下:
​     线上环境IP地址:xxx
​     线上环境AppKey,AppSecret等参数已经发给你方对接开发。
​     请使用线上环境SkuID进行实单验证,请在完成之后以邮件的形式申请启用线上渠道。

渠道方申请修改线上环境相关配置

严选团队:
     严选团队,你们好。现我方申请修改线上环境的相关配置:
     修改参数: IP白名单/统一回调URL
     修改类型:增加/覆盖
     修改内容: xxx
     更新原因:xxx
     烦请你方尽快完成线上环境的相关配置。

严选技术回复更新线上环境配置邮件模板

XXX(渠道):
    XXX(渠道),你们好。我方已更新线上服环境配置。

Step4. 发布上线

流程

  • 渠道方接入线上环境

    • 渠道方根据严选提供的线上环境参数,配置渠道方线上环境,采用严选提供的实单
    • 验证SkuId在严选线上环境进行线上回归及实单验证。
      特别强调,线上回归时仅可使用测试服测试通过的非压力测试用例,请务必遵守以下规定:
      • 严禁使用未通过测试服测试的用例或新用例,
      • 严禁压力测试

邮件要求

渠道方申请上线邮件模板

严选团队:
​     严选团队,你们好。我方已完成线上环境的实单验证,现申请启动线上渠道。

严选技术回复上线申请失败邮件模板

XXX(渠道名称):
​     XXX,你们好。我方已收到你方启动线上渠道的申请。非常遗憾,您的线上渠道的审核结果为审核失败。失败原因为:.......

严选技术回复上线申请成功邮件模板

XXX(渠道名称):
​     XXX,你们好。我方已收到你方启动线上渠道的申请,现已完成启动,敬请周知。

附录:渠道接入测试环境

请渠道方务必根据以下说明接入测试环境自测

 

一、参考《OpenAPI 对接Demo》开发API对接模块

  1. 根据严选提供的测试环境参数配置API对接模块
  2. 完成接口测试
  3. 根据严选提供的测试SkuId生成模拟订单数据
  4. 根据严选提供的查询接口查询相关信息

    • 联调yanxuan.item.id.batch.get
      方法:渠道方通过该接口查询商品Id列表

    • 联调yanxuan.item.batch.get
      方法:渠道方可以根据商品Id获取该商品的详细信息

    • 联调yanxuan.inventory.count.get
      方法:渠道方可以根据SKUID获取对应的库存信息

 

二、参照《OpenAPI接口文档》,使用模拟订单联调接口

  1. 联调yanxuan.order.paid.create
    方法:渠道方能使用模拟订单进行下单,严选OMS系统在渠道方下单成功之后能查到订单数据

  2. 联调yanxuan.order.paid.get
    方法:渠道方能根据下单成功的订单号查询到订单详情

  3. 联调yanxuan.order.received.confirm
    方法:如下:

    • 严选客服模拟订单发货,严选OMS系统中订单状态更新为“待收货”
    • 渠道方调用yanxuan.order.received.confirm
    • 确认成功之后严选OMS系统中订单状态从“待收货”转变为“待评论”
  4. 联调yanxuan.order.paid.cancel
    方法:在订单处于“待发货”状态时,渠道方调用yanxuan.order.paid.cancel

    • 若订单为自动仓订单,则直接完成取消,OMS系统中订单状态由“待发货”转变为“客服取消”
    • 若订单为外部仓订单,则需要严选客服进行审核,此时订单状态由“待发货”转变为“取消待审核”
  5. 联调统一回调URL的yanxuan.callback.order.cancel
    方法,如下:

    • 严选客服审核通过或拒绝渠道方取消订单的请求
    • OMS系统中订单由“取消待审核”转变为“客服取消”或“拒绝取消”,并将结果通过渠道方提供的取消回调接口返回给渠道方
  6. 联调统一回调URL的yanxuan.notification.order.delivered
    订单绑定方法:

    • 严选客服模拟订单发货
    • OMS系统收到发货通知后,会将订单的包裹绑定到相应的物流,并通过渠道方的订单绑定回调接口将绑定结果返回给渠道方