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

文档说明

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

对接流程

第一步 明确接入需求

流程

流程1

邮件要求

严选市场邮件模板

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

严选产品技术:
  严选产品技术,你们好。XXX渠道现需进行API对接,请严选产品技术团队安排相关人员协作完成对接工作。

严选产品技术邮件模板

XXX(渠道名称):
​  XXX,你们好。我方已收到你方对接申请,附件为《严选渠道对接流程》、《OpenAPI接口文档》、
 《OpenAPI对接Demo》,敬请查看。我们将根据《严选渠道对接流程》于你方协作完成API对接工作,现需你方
  提供一下配置信息:测试环境IP白名单,统一回调URL,这些配置信息将用于配置严选测试环境,以便进行API
  对接的开发测试

重要说明

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

第二步 配置并验证测试环境

流程

流程1

详细说明:

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

收到渠道方的申请邮件之后,向渠道方请求测试环境下的 IP 白名单、统一回调 URL,并将《严选渠道对接流程》、《OpenAPI 接口文档》、《OpenAPI 对接Demo》作为附件,以邮件的形式发送至渠道方的邮箱。

渠道方回复测试环境参数

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

严选技术配置测试环境

严选根据渠道方提供的参数,在测试环境中将渠道信息录入分销系统,配置IP白名单、统一回调URL,为渠道生成AppKey及AppSecret,并申请渠道测试IP白名单的外网访问权限,添加测试Sku并划拨库存。
严选将测试环境中的AppKey及AppSecret、测试SkuId、OpenAPI测试环境URL以邮件的形式发送至渠道方的邮箱。

渠道方接入测试环境

渠道方根据《OpenAPI接口文档》、《OpenAPI对接Demo》以及严选提供的测试环境参数进行开发测试:

  1. 渠道方参考《OpenAPI 对接Demo》开发API对接模块;
  2. 渠道方根据严选提供的测试环境参数配置API对接模块;
  3. 渠道方完成接口测试
    1. 渠道方根据严选提供的测试SkuId生成模拟订单数据;
    2. 渠道方根据严选提供的查询接口查询相关信息
      1. 联调yanxuan.item.id.batch.get方法:渠道方通过该接口查询商品Id列表;
      2. 联调yanxuan.item.batch.get方法:渠道方可以根据商品Id获取该商品的详细信息
      3. 联调yanxuan.inventory.count.get方法:渠道方可以根据SKUID获取对应的库存信息;
    3. 参照《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系统收到发货通知后,会将订单的包裹绑定到相应的物流,并通过渠道方的订单绑定回调接口将绑定结果返回给渠道方;
  4. 渠道方完成集成测试
    1. 渠道查询商品列表——渠道查询商品信息——渠道维护渠道展示信息(库存为0的下架或不可卖)
    2. 严选回调库存划拨方法——渠道查询库存——渠道更新库存信息——渠道是否可下单
    3. 渠道下单——严选发货(订单绑定)——严选回调订单绑定方法——渠道更新订单信息——渠道确认收货
    4. 渠道下单——渠道取消订单——订单取消成功(或失败)
    5. 渠道下单——严选回调异常方法——渠道更新订单信息
    6. 渠道下单——渠道取消订单——严选客服审核——严选回调订单取消方法
    7. 渠道下单——严选发货——渠道取消订单——取消失败

邮件要求

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

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

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

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

第三步 配置并验证线上环境

流程

流程1

补充说明

渠道方申请接入线上环境

渠道方开发测试完成之后,将线上环境下的IP白名单、统一回调URL以邮件的形式发送至严选邮箱,申请接入严选线上环境。

严选技术审核申请

严选审核渠道方在测试环境下的开发测试结果以及渠道方线上环境配置参数,评估渠道接入风险,审核是否允许渠道方接入严选线上环境:

  1. 审核失败,将审核失败原因以邮件的形式回复至渠道方的邮箱;
  2. 审核通过,严选为渠道方配置线上环境。
严选技术配置线上环境

严选在线上环境中将渠道信息录入分销系统,配置IP白名单、统一回调URL,为渠道生成AppKey及AppSecret,创建线上实单验证Sku并划拨库存。

严选将线上环境中的AppKey及AppSecret私信告知渠道对接开发,实单验证SkuId、OpenAPI线上环境URL以邮件的形式发送至渠道方的邮箱。

渠道方接入线上环境

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

验证通过之后,渠道方以邮件的形式向严选申请启用线上渠道。

严选技术审核上线请求

严选审核渠道方线上验证结果,评估线上渠道启用风险,审核是否启用线上渠道:

  1. 审核失败,将审核失败原因以邮件的形式回复至渠道方的邮箱;
  2. 审核通过,启用线上渠道,以邮件的形式通知到渠道方。

邮件要求

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

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

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

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

渠道方申请上线邮件模板

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

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

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

第四步 发布上线

对接完成,归档对接流程。