【官方教程】淘宝客API/SDK介绍总帖

霍常亮 2022年1月17日淘宝客教程 1,151 0

文章目录[隐藏]

淘宝客API/SDK介绍总帖
- 一、请先了解api调用的方式：
- 二、淘宝联盟提供哪些API/SDK服务？

淘宝客API/SDK介绍总帖

帮你快速概览联盟API、SDK，如何获得权限，及如何使用！

淘宝客API功能开放给在联盟平台完成备案的淘宝客使用，SDK目前为百川电商SDK。

【导航站】

一、请先了解API调用的方式

二、淘宝联盟提供哪些API/SDK服务

三、如何获取权限

四、FAQ

------------------------------------------------------------------------------------

一、请先了解api调用的方式：

淘宝客API调用，必须完成媒体备案，创建推广位（即pid）之后，才可生成appkey，进行API调用。

说明：

1、pid如何生成：

淘宝客需先完成媒体备案，在对应媒体ID下，创建推广位。点击了解《淘宝客推广者备案新手指南》

2、pid的三段数字含义：

淘宝客pid由三段数字组成 pid=mm_1_2_3（其中1/2/3分别代表一串数字，举例pid=mm_98836808_12970065_68140878），其中1这串数字对应淘宝客的账户id(通常称member)；2这串数字对应媒体备案管理中的媒体ID(通常称site)；3这串数字对应媒体ID下的具体推广位(通常称adzone)。

3、哪些媒体ID可获得appkey：

媒体备案中，除了“线下-个人、单门店”、、“站内达人平台自动生成的site”这几类媒体ID之外，其他均可申请appkey，每一个媒体ID对应生成一个appkey（一一对应），调用api时系统会校验是否应用于对应媒体阵地内。如果appkey不匹配或传递参数错误，会不算淘宝客交易，切记!

二、淘宝联盟提供哪些API/SDK服务？

能力地图概况

赋能对象：推广者

能力类型	包含内容
物料类	信息查询(商品/店铺、优惠券) \| 精品(精选商品库/榜单/猜你喜欢/商品关联推荐/选品库的等批量商品获取) \| 搜索(商品、店铺) \| 关联推荐(店铺)
基建类	唤端联动(唤醒/授权免登) \| 转链(商品/店铺转链、单品高效转链、三方转链、活动转链、淘口令、长链转短链)
组织管理类	私域用户管理(渠道管理、会员运营管理)
数据类	订单明细(所有订单/维权退款订单、处罚订单) \| 拉新订单效果 \| 淘口令回流数据
营销类	淘礼金

1、物料类能力

功能点	权限包名称	API名称	API介绍地址	功能描述	如何获得
①信息查询(商品/店铺、优惠券)	淘宝客【公用】物料信息查询	淘宝客-公用-淘宝客商品详情查询(简版)	taobao.tbk.item.info.get	输入批量商品id，查询对应淘宝客商品的详情页详细字段（简版）	默认可申请
①信息查询(商品/店铺、优惠券)	淘宝客【公用】物料信息查询	淘宝客-公用-阿里妈妈推广券详情查询	taobao.tbk.coupon.get	输入商品ID+券ID，或者传入me参数，查询对应阿里妈妈推广券信息	默认可申请
②精品(精选商品库/榜单/猜你喜欢/商品关联推荐/选品库的等批量商品获取)	淘宝客【推广者】物料精选	淘宝客-推广者-物料精选	taobao.tbk.dg.optimus.material	输入pid、物料id，输出对应物料库的店铺/商品/类目/券/拼团等详细字段信息。【看material_id请点击】(聚划算/淘抢购/猜你喜欢/商品关联推荐/大额券/品牌券等物料均在此，且包含pub平台选品库批量获取)	默认可申请
③搜索(商品、店铺)	淘宝客【推广者】物料搜索	淘宝客-推广者-物料搜索	taobao.tbk.dg.material.optional	输入pid(必选)、物料id或各种筛选字段，输出对应商品的店铺/商品/类目/券/拼团等详细字段信息	默认可申请
③搜索(商品、店铺)	淘宝客【推广者】物料搜索	淘宝客-推广者-店铺搜索	taobao.tbk.shop.get	淘宝客店铺查询	默认可申请
④关联推荐(店铺)	淘宝客【公用】关联推荐	淘宝客-公用-店铺关联推荐	taobao.tbk.shop.recommend.get	输入店铺id，查询与此店铺关联或相近的店铺及店铺店铺详情信息	默认可申请

2、基建类能力

①唤端联动(唤醒/授权免登)

需通过百川电商SDK实现唤端、授权免登，百川电商SDK申请入口：https://baichuan.taobao.com/product/esdk.htm?spm=a3c0d.7662652.1998907869.3.100abe48ToF8Iw

②转链类

功能点	权限包名称	API名称	API介绍地址	功能描述	如何获得
活动转链	淘宝客【推广者】官方活动转链	淘宝客-推广者-官方活动信息获取	taobao.tbk.activity.info.get	从官方活动列表页取出官方活动ID，支持二方、三方	默认可申请
淘口令	淘宝客【公用】淘口令生成	淘宝客-公用-淘口令生成	taobao.tbk.tpwd.create	提供淘客生成淘口令接口，淘客输入口令内容、logo、url等参数，生成淘口令关键key如：￥SADadW￥，后续进行文案包装组装用于传播。输入商品信息，广告位信息，转成淘口令。目前淘口令的有效期是30天，我们的API没有做特殊逻辑，有效期等同于淘口令有效期	默认可申请
长链转短链	淘宝客【公用】长链转短链	淘宝客-公用-长链转短链	taobao.tbk.spread.get	输入一个原始的链接，转换得到指定的传播方式，如二维码，淘口令，短连接；现阶段只支持短连接。短连接有效期300天	默认可申请

以下为邀约制

功能点	权限包	API名称	API介绍地址	功能描述	如何获得
单品高效转链	淘宝客【推广者】单品券高效转链	淘宝客-推广者-单品券高效转链	taobao.tbk.coupon.convert	根据商品ID，Me参数，可查询最高佣金比例，券的相关数据，也可直接输出转链的二合一页面	邀约制
商品/店铺转链	淘宝客【推广者】商品或店铺链接转换	淘宝客-推广者-商品链接转换	taobao.tbk.item.convert	普通商品转链，营销/定向/通用。媒体可以指定走什么计划，如果不传指定参数1进来，走营销，如果指定参数1，就走定向（若有关系）或通用	邀约制
商品/店铺转链	淘宝客【推广者】商品或店铺链接转换	淘宝客-推广者-店铺链接转换	taobao.tbk.shop.convert	店铺转链接，通用计划	邀约制
三方转链	淘宝客【推广者】三方分成链接转换	淘宝客-推广者-商品三方分成链接转换	taobao.tbk.item.share.convert	三方分成商品通用类链接或营销类链接	邀约制
三方转链	淘宝客【推广者】三方分成链接转换	淘宝客-推广者-店铺三方分成链接转换	taobao.tbk.shop.share.convert	三方分成店铺转链接	邀约制

3、组织管理类

①、私域用户管理

1-1：渠道管理：提供淘宝客发展帮助自己推广的渠道，并对其进行管理的能力。

如需申请【点击功能介绍及申请帖】

1-2：会员运营管理：提供帮助淘宝客沉淀自己的会员，进行精准的二次营销、会员管理和营销返利等服务的能力。

如需申请【点击功能介绍及申请帖】

以上两者统一的API权限包：

填写申请表时，提交appkey，即可默认获得，同时还可默认获得两个订单权限包淘宝客【推广者】推广订单及数据查询+淘宝客【推广者】处罚订单查询

功能点	权限包名称	API名称	API介绍地址	功能描述	如何获得
私域用户管理	淘宝客【公用】私域用户管理	淘宝客-公用-私域用户邀请码生成	taobao.tbk.sc.invitecode.get	邀请码生成功能	如需申请【点击功能介绍及申请帖】默认可申请
		淘宝客-公用-私域用户备案	taobao.tbk.sc.publisher.info.save	根据邀请码，查询相应的渠道关系id或会员运营id
		淘宝客-公用-私域用户备案信息查询	taobao.tbk.sc.publisher.info.get	输入渠道类型/会员类型，或再输入渠道关系id/会员运营id，查询对应各id备案填写的信息

私域用户管理规范：https://rule.alimama.com/#!/product/index?type=detailid=405knowledgeId=9350

《私域用户管理能力之新手指南（for媒体）》

4、数据类能力

①拉新数据

基础：默认可申请

功能点	权限包名称	API名称	API地址	功能描述	如何获得
拉新订单效果	淘宝客【推广者】新用户订单及数据查询	淘宝客-推广者-新用户订单明细查询	taobao.tbk.dg.newuser.order.get	查询拉新新人手机号、时间、订单、推广者等信息	默认可申请
拉新订单效果	淘宝客【推广者】新用户订单及数据查询	淘宝客-推广者-拉新活动对应数据查询	taobao.tbk.dg.newuser.order.sum	输入pid和活动id，查看每个拉新活动对应的数据	默认可申请

②订单明细数据

功能点	权限包名称	API名称	API地址	功能描述	如何获得
订单明细(所有订单/维权退款订单)	淘宝客【推广者】推广订单及数据查询	淘宝客-推广者-所有订单查询	taobao.tbk.order.details.get （老apitaobao.tbk.order.get计划下线。点击看通知）	输入查询时间，返回对应订单卖家、商品、金额、佣金、媒体等详细数据	邀约制
订单明细(所有订单/维权退款订单)	淘宝客【推广者】推广订单及数据查询	淘宝客-推广者-维权退款订单查询	taobao.tbk.relation.refund	维权退款的订单，支持二方和三方的渠道or会员订单	邀约制
订单明细(处罚订单)	淘宝客【推广者】处罚订单查询	淘宝客-推广者-处罚订单查询	taobao.tbk.dg.punish.order.get	新增处罚订单查询API，提供媒体调用查询能力。	邀约制

③淘口令回流数据

功能点	权限包名称	API名称	API地址	功能描述	如何获得
淘口令回流数据	淘宝客【推广者】淘口令回流数据	淘宝客-推广者-淘口令回流数据查询	taobao.tbk.dg.tpwd.report.get	淘宝客获取单个淘口令的回流PV、UV数据。	默认可申请

5、营销类能力

淘礼金功能权限申请：联盟APP—>我的—>营销工具—>淘礼金。申请规则【请点击】

功能点	权限包名称	API名称	API地址	功能描述	如何获得
淘礼金	淘宝客【推广者】淘礼金营销	淘宝客-推广者-淘礼金创建	taobao.tbk.dg.vegas.tlj.create	淘礼金创建	默认可申请，但需先申请淘礼金功能权限才可使用API
淘礼金	淘宝客【推广者】淘礼金营销	淘宝客-推广者-淘礼金发放及使用报表	taobao.tbk.dg.vegas.tlj.instance.report	淘礼金引导的效果报表	默认可申请，但需先申请淘礼金功能权限才可使用API
淘礼金	淘宝客【推广者】裂变淘礼金	淘宝客-推广者-裂变淘礼金创建	taobao.tbk.dg.vegas.lbtlj.create	创建可裂变的淘礼金，并获得对应发放/核销等数据	默认可申请，但需先申请淘礼金功能权限才可使用API

三、如何获取权限

1、完成阿里妈妈账号注册、完成推广阵地的备案后，可进入淘宝联盟开放平台申请API权限：

淘宝联盟开放平台：https://aff-open.taobao.com/

从该平台中可对默认开放API直接申请，若API邀请制，需要和联盟商务/运营沟通业务场景。

若有相关问题，可在淘宝联盟开放平台顶部的“答疑中心”提交工单咨询。

百川SDK获取权限：唤端、授权免登功能：https://baichuan.taobao.com/product/esdk.htm?spm=a3c0d.7662652.1998907869.3.100abe48ToF8Iw

2、准入及清退规则：

准入规则：符合以下标准的淘宝客推广者可以申请：

①、须为阿里妈妈激活会员，并绑定符合阿里妈妈要求的支付宝账户。

②、阿里妈妈账户内因特定类型的淘宝客违规而产生的生效中的累计扣分＜18分。解读

③、账户对应的关联账号未在阿里妈妈存在历史违规作弊情形。

清退规则：出现以下情节，阿里妈妈将禁止调用API权限或终止该推广者的API使用权限，因此导致的推广内容无法展现、收入无法统计支取等由推广者自行负责。

①、不符合API权限包开放规则。

②、拥有api权限的推广者连续30天对应API无调用量或无成交量。解读

③、拥有高级API权限(即邀约制API)的媒体，月日均点击量小于5万或月日均alipay金额小于10万。

④、申请的api权限用于非申请时提供的媒体备案渠道内，或未经阿里妈妈事先同意擅自开放给第三方进行调用。

⑤、随意删减、修改淘宝客API接口，或调用淘宝客API接口用以开发插件类应用或依附于客户端（含浏览器）的插件。

⑥、泄露淘宝客API权限的用户名和密码等隐私信息。

⑦、违反《阿里妈妈推广者规范》其他规范的。

3、获取步骤：

① 在阿里妈妈后台备案并审核通过，即可点击“APPKEY申请”去联盟开放平台创建appkey

②进入淘宝联盟开放平台后，点击右上角“新建应用”，选择对应的媒体备案，基于该媒体备案生成appkye（媒体备案id与appkey一一对应），appkey生成后，即可在联盟开放平台中看到对应的权限包和所包含的API，默认开通的可自助申请，高级权限在基础开放条件上为邀约制，小二会根据媒体的发展情况，邀约达成合作意向后开通。