文档中心 > 开发文档

开发入驻指南

更新时间:2023/10/23 访问次数:3381

名词解释

1.淘宝开放平台(下称:“开放平台”):指基于淘鲜达平台各类电子商务业务的开放,由淘鲜达提供一些软件和支持材料,开发者通过这些软件和支持材料开发应用以便服务于自身或服务于淘鲜达平台其他用户。开发者可以通过开放平台应用编程接口调用指定的功能服务,访问由淘鲜达提供的或用户授权的与用户相关的数据和/或来自其他淘鲜达应用程序的数据信息,或者由开发者应用向淘鲜达提供、回流数据。开放平台可能包括但不限于一个或多个API、编程工具和文档。

2.开发者:按照开放平台流程经有效注册、申请并通过验证的可以基于开放平台进行应用开发的单位或者个人,在开放平台开发者也可称为“开发者”。

3.用户:指可通过达成交易意向等方式获取服务商服务或使用服务商所开发应用的淘鲜达平台商家。

4.应用:指开发者基于开放平台所开发的软件或服务。

5.店铺和店铺ID:用户在淘鲜达平台所开设的网络店铺,以及店铺的唯一标识数字。需要注意的是,用户和店铺是一对多的关系,即一个商户可以开设和管理多家店铺。

7.App ID & secret: 指开发者在申请开发新应用时获得的由淘鲜达授予的应用程序接入账户和密钥。secret是应用的唯一标识,淘鲜达通过App ID来识别应用开发者的身份。secret是淘鲜达给应用分配的密钥,该密钥在一定技术条件下可保证应用来源的可靠性。

9.APIApplication Programming Interface):开放平台为第三方应用接入提供的编程接口,具体接口说明,参见API文档列表。

10.授权(Token):开发者所开发的应用想要访问用户的信息,则必须经过用户的同意,由应用发起的用户是否同意访问的操作称之为授权。

11.推送:开放平台向应用发送“新订单”、“退款”等信息,称之为向应用推送信息。

12.回调:用户同意或拒绝应用的授权请求后,开放平台打开应用设置的回调URL并附加上商户同意或拒绝的操作信息,称为开放平台回调应用。

一、淘宝开放平台入驻流程详解

1.1、开放平台入驻流程

开发者可以按照指引流程完成平台账的账号注册和认证、类目资质认证、应用创建和商家授权环节详细流程可以访问https://tc.open.taobao.com/doc.htm?docId=118722&docType=1 (淘宝开放平台文档中心)

image

1.1.1账号注册

即注册成为淘宝开放平台开发者,您可以访问账号注册页面使用手机+验证码登录即可

image

前置条件:
成为开发者之前需要有一个可以登录淘宝的账号,并且这个账号绑定的支付宝账号是企业认证的账号。
备注:个人账户不支持(会提示“企业资质认证 你的支付宝账号不是企业资质认证”)
注册淘宝账号地址:https://reg.taobao.com/member/reg/fast/union_reg?_regfrom=TB
注册企业认证支付宝地址:https://memberprod.alipay.com/account/reg/enterpriseIndex.htm

1.1.2创建应用


点击这里创建应用

如果第一次申请应用,会弹出以下页面,提交申请可以创建淘鲜达平台对应的标签下应用权限
image

点击下一步即可,会进入如下页面,等待申请结果,一般会通过邮件告诉申请结果。

image

如果不是第一次申请应用,或者已经审批通过,则会弹出以下页面

image

  • 输入应用名称,点击创建应用即可,对于应用名称没有强制约束,创建成功后会跳转到应用概览界面,查看创建好的appkey和secret。
  • 也可以点击这里进入应用控制台,找到刚才创建好的应用,即可看到对应的appkey和secret。

image

注意??:开发者入驻完成后请联系与您对接的淘鲜达技术小二,对开发者身份申请进行审批
需提供:开发者名称
image

1.1.3申请淘鲜达工作台商家账号

需要申请是商家在淘鲜达上的账户信息,用户管理淘鲜达商家资料和数据信息等相关(默认为正式环境账户),申请的接口人为当时做业务对接的时候负责淘鲜达setup的同学。

备注:需提供资料:个人手机号码、姓名

1.1.4开发测试

接下来就可以开始写代码调用淘鲜达平台开放的api接口,具体如何调用,以及如何测试,在接口调用和测试指南一节会详细讲述

整个开发测试的整个流程分为三个阶段,

  1. 淘鲜达开放平台的技术支持和三方开发的同学编写代码和自测。
  2. 自测完成之后三方开发和淘鲜达开放平台的测试同学针对每个模块进行单独的测试,比如:针对交易模块测试,针对店仓模块测试。
  3. 每个模块测试完成之后,需要全链路的串通测试,从渠道下单,到最后的ERP操作。

1.1.5正式发布

如果测试完成,验证没有问题,代码可以发布上线,正式对外服务。

1.2、奇门入驻

1.2.1奇门入驻配置

重申提醒:须完成前面的淘鲜达开放平台入驻和应用创建。

开放平台出口IP介绍://open.taobao.com/announcement.htmspm=a219a.7386653.0.0.STZ4py&source=search&docId=25365&docType=12

1.2.2申请成功奇门开发者

如果之前没有操作过奇门的新账户,在登录后界面会提示“您不是奇门开发者” 此处需要登记下信息提交。(老用户忽略)

PS:仅是申请加入,录入联系人信息提交即可。最终会提示“已成为奇门开发者”

如下图所示例:

image

image

image

然后就可以继续进行后面的官方场景关联了。

二、资源配置&权限申请

1、奇门权限场景&权限包申请

奇门场景:同城零售开放场景 场景添加可以找 技术小二 添加

权限包:同城零售开放平台权限组 权限组添加可以找 技术小二 添加

注意??:此处权限包与奇门场景配置请联系与您对接的淘鲜达技术小二一起根据业务场景开通对应权限包&奇门场景

2、奇门场景配置

2.1奇门接场景接入

官方场景查看请进入:https://work.open.taobao.com/qimenofficialNew

进入奇门控制台(如果没有登录,则会跳转到登录页面,或许登录后发现进入了公共页面,可重新打开地址),关联场景如下图所示

  • PS说明:点击“官方集成-官方集成(新)”,可以看到已经添加的奇门场景。
  • 如果没有看到官方集成场景,请联系与您对接的技术小二协助。

image

2.2配置实现奇门接口

  • 官方场景(新)进入点击接入对应的奇门API,点击接入

image

2.5请求地址配置(即商家ERP服务端地址)

这一步主要配置三方实现这个接口对外网可以访问的HTTP URL。奇门会请求这个URL,然后获取到结果。如下图所示(这个地址商家端要依赖SDK实现功能开发)

需要注意的点

*配置的URL,必须要外网可以访问。

*配置的URL中如果有参数的话,对于参数的key不能出现开放平台保留的参数key,比如:这个URL,http://www.example.com/payment?method=xxx。其中method这个参数是开放平台保留的参数key,不能出现在配置的URL中。具体哪些参数key是保留的可以看这里

//open.taobao.com/doc.htm?docId=101617&docType=1#s2

image

备注??:即使在测试联调,此步骤也需要走完全部流程(即服务上线)

3、开发接入须知

3.1通用指南

3.2API接口调用说明

3.2.1SDK环境依赖

JAVA SDK 需要依赖 Java SE/EE 1.5及以上

.NET SDK 需要依赖 .NET Framework 2.0及以上 (不支持Windows Phone平台)

PHP SDK 需要依赖 PHP 5及以上

Python SDK 需要依赖 Python 2.7以及上

详情可访问://open.taobao.com/doc.htm?docId=101618&docType=1#s2

3.2.2使用官方SDK对接,请按需下载SDK

访问开放平台控制台地址:http://console.open.taobao.com/#/app/manager?_k=rogwe7

选择商家自己创建的应用---“应用管理” 进入应用管理详细页面,

然后选择左侧“SDK下载” 见下图。

image

image

注意??:下载SDK之前一定要联系淘鲜达技术小二给您添加好奇门场景&权限组

3.2.3不使用官方SDK对接

可以阅读:https://open.taobao.com/doc.htm?docId=112&docType=1#s2

3.3获取授权token

授权是商家对三方应用的获取商家数据的一个许可,如果没有这个许可,那么三方应用是不能拿到商家的数据的。

  • 设置应用的回调地址,这个回调地址用于接收淘鲜达开放平台生成的商家授权许可token,如下图所示:

image


  • 【说明】回调地址填写为自己的系统中的外网可以访问的一个地址。开放平台生成code后会回调这个地址,然后这个地址对应的处理代码从参数中获取code参数。
  • 【说明】回调地址填写为自己的系统中的外网可以访问的一个地址。开放平台生成code后会回调这个地址,然后这个地址对应的处理代码从参数中获取code参数。
  • 获取授权code(注意此code并不是最终的token)。访问以下URL登录淘鲜达系统获取授权code:
    - 正式环境: http://oauth.hemaos.com/authorize?response_type=code&sp=hema&op=topApp&client_id=商家应用appkey

参数说明:
- response_type:请求授权类型,固定为”code”。
- sp:业务线,固定为”hema”。
- op:固定为 ”topApp”。
- client_id:商家申请接入时分配给商家的appkey。登入界面如图:(首次登录,需要“设置密码”)

淘鲜达工作台链接:https://sx.dchain.tmall.com/login?from=https%3A%2F%2Fsx.dchain.tmall.com%2F

image

登录淘鲜达平台账号成功后,页面会跳转到事先配置好的回调地址(在淘宝开放平台,应用设置->基本信息页面里有配置),跳转的回调地址中会携带授权code。返回值示例,如下图所示

image

  • 【说明】 授权code并不是最终的token,只是为了安全起见,采用2次置换的方式。在回调地址的URL中,明文携带token很不安全。因此采用先拿到授权code,再使用授权code去置换token的方式,提高安全性。
  • 获取授权token。三方应用拿到code,携带自己应用的appkey,secret,code,去置换对应商家的token。拿到token,使用client.execute(request, session); 可以进行正常使用。置换代码如下:
  • 接口:taobao.top.auth.token.create( 获取Access Token )
  • 接口文档:https://open.taobao.com/api.htmspm=a219a.7386797.0.0.2090669azsNr2r&source=search&docId=25388&docType=2

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secretkey); TopAuthTokenCreateRequest req = new TopAuthTokenCreateRequest(); //此处为上面通过登录淘鲜达工作台拿到的授权code req.setCode("0_ebKlCPqc6OD8RBlB0DzfnpUg2"); TopAuthTokenCreateResponse rsp = client.execute(req); System.out.println(rsp.getTokenResult());//返回json

返回示例

{ "top_auth_token_create_response": { "token_result": "{\"wdk_company_id\":\"test\",\"refresh_token_valid_time\":1677119664830,\"expire_time\":1692671664830,\"locale\":\"zh_CN\",\"user_nick\":\"%E5%B0%B9%E9%94%90\",\"access_token\":\"50002t00702c3m1b47fed9yer8joswPUdC5mTEovAywhaGCPCmxTgjltIpjpc8FMXsp\",\"refresh_token\":\"50003t00702c3m1915b673yer8joswPUdC5mTEovAywhaGCPCmxTgjltIpjpc8FMXsp\",\"w1_valid\":1692671664830,\"w2_valid\":1677121464830,\"user_id\":\"2208280754968\",\"r2_valid\":1677378864830,\"r1_valid\":1692671664830,\"sp\":\"hema\"}", "request_id": "15relsl0poylq" }

返回参数说明

- access_token: 用于调用TOP接口的token
-wdk_company_id淘鲜达商家编码
- expire_time: 表示授权在这个时间之后就无效了,需要重新授权,为了保证业务正常运行,需要在这个过期时间之前,让商家登录重新授

  • 授权需要注意的点
  1. 商家的授权是有时长限制的(有效期180天),为了确保业务不间断运行,需要在授权过期之前让商家再次登录淘鲜达平台生成新的授权token,之所以这么做是为了确保商家的数据的安全,不至于因为设置了一个很长的授权时长导致当商家不在使用三方应用的时候三方应用依然能获取到商家的数据。

3.4常见问题如何处理

3.4.1API常见问题提问建议模板
  • API请求报错问题,需提供:报错信息,包含request_id方便快速定位问题
调用时间:   2023-03-04 21:41:28
接口名称:   alibaba.wdk.sku.query
请求参数:   {param={"ou_code":"TXDCSSJ","sku_codes":["20001453684001"]}}
响应结果:   {"alibaba_wdk_sku_query_response":{"result":{"err_code":"ILLEGAL_PARAMETERS","err_msg":"未找到门店机构信息","success":false},"request_id":"15rcj9cs4dec0"}}
  • API使用问题,需提供:API名称+疑问点+疑问截图(如有)+文档链接(如有),方便淘鲜达技术同学快速确定您的问题,给出对应的回复。
3.4.2日志推送问题提问建议模板
  • 日志消息未收到,需提供:消息名称+测试的大概时间节点+关键信息(订单号、售后单号、商品ID、Appkey)+文档链接(如有),方便淘鲜达技术同学快速确定您的问题,给出对应的回复
  • 日志消息触发推送规则,需提供:消息名称+疑问点+疑问截图(如有)+文档链接(如有),方便淘鲜达技术同学快速确定您的问题,给出对应的回复。
3.4.3产品功能使用类
  • 主要承接人:各群淘鲜达运维人员
  • 需提供:功能名称/信息+问题说明+截图(如有)+文档链接(如有)方便淘鲜达小二快速定位问题,给出对应的答复。

FAQ

关于此文档暂时还没有FAQ
返回
顶部