当前位置:淘客联盟接口开发文档(旧版) > [旧]超级搜索接口
接口文档

(旧版)超级搜索接口-淘宝联盟强大搜索功能帮你把握成交概率

【必看:关于本接口更换新版的特别说明】

本接口已停止更新,更换为新的tb_search接口,参考 http://www.veapi.cn/doc/taokesousuojiekou

原有在使用本接口的用户,不影响使用。但后续如无必要,此接口不会升级维护。推荐更换为新的搜索接口tb_search。

请新接入的用户,移步 http://www.veapi.cn/doc/taokesousuojiekou ,使用新的搜索接口。


维易超级搜索接口使用说明:

超级搜索接口——超越市场上主流淘客APP的强大搜索引擎!

更好把握每一次成交机会!


本超级搜索接口完全按客户在APP或公众号、网站的搜索场景来开发。搜索接口具有以处功能和特征:

1、【强大的参数处理能力】接收五花八门的关键字进行泛搜索,获取产品列表。经近3年的升级,可处理各种非常规关键字

2、【定向搜索】当您的客户使用从手淘等处复制的淘口令/喵口令、五花八门链接等内容,接口将直接转链出客户指定的产品。

3、【找相似功能】当查找淘宝联盟以外的商品时,普通搜索无法获取结果,而本接口独有淘宝联盟官方APP一样的“找相似”功能可以增加用户成交机会。

4、【完全高佣】搜索获取的产品全部显示高佣,方便您在应用中准确计算分享给客户的佣金金额。

5、【APP上架帮助】苹果系统APP上架需要过滤虚拟产品,搜索接口提供了虚拟产品过滤功能,帮助您的APP顺利上架。

6、【精准提词功能】有时搜索标题关键字在搜索时,淘宝无返回值或不准确,此时本接口将触发维易全网独有的标题精准提词功能,精准分析用户搜索意向产品,返回搜索结果。比如“95%绒子羽绒被白鹅绒被蓬松羽绒被芯被子”搜索词,联盟官方接口上返回的是宠物玩具、丝袜等不相关词,而维易接口有提词功能介入,可以得到“羽绒被”结果。

又如“大琳手作 复古摩登中式气质屏风原创设计防过敏银耳钉耳夹无耳洞”,市场上的APP基本搜索结果都是毫不相关的“屏风”产品,而不是“银耳钉”,使用维易接口可以得到正确耳钉结果。

参考“电商标题提取产品词接口”:http://www.veapi.cn/doc/biaotijingzhuntici

本搜索接口经过长期的不断升级和客户反馈,为您的APP打造强大的搜索能力。


一、接口地址:

【注】请新接入的用户不要再使用本接口,

移步http://www.veapi.cn/doc/taokesousuojiekou  使用新版的搜索接口。


http://api.veapi.cn/tbk/super?vekey=V1231xxxxxxx&para=各种关键字/淘口令/链接等参数


【案例】 如何用超级搜索功能做 9.9元包邮?


二、接口功能:

接口所有搜索返回的产品列表显示的佣金都是高佣金。

接口增强:1、长标题搜索无结果时进行精准提取产品词搜索。2、淘宝联盟以外的商品进行标题搜索找相似。

【注意】

本接口根据参数不同,启用不同类型的搜索:关键字匹配泛搜索和指定产品的定向搜索


1、关键字匹配搜索——使用关键字或商品标题搜索符合条件产品列表。

用于你的客户,在APP或网站或公众号等应用中,直接使用关键字或产品标题来搜索(文字请做url编码传递)。接口对内容做了优化,当无结果时,将进行精准提取产品词搜索。

http://api.veapi.cn/tbk/super?vekey=V000xxxx&para=拉杆箱


也可以用分类ID查,使用 cat参数(详细淘宝分类数据请联系客服),这时可不必传递para,如:

http://api.veapi.cn/tbk/super?vekey=xxxxx&cat=50011129

【注意】更多参数请阅读下文。


2、直接定向搜索指定产品:

顾客在您的APP或网站,不会每次都是输入产品关键字来搜索,很多时侯,她会输入一个手淘APP或者同行那里复制的淘口令/喵口令、或者各种五花八门的淘宝天猫链接等等,看看你这里有没有这个产品的优惠券。

面对这种场景,当您把顾客输入的这些“产品id,链接,淘口令...”等内容时,接口理解为客户指定搜索该产品,这时如果返回一堆产品列表,反而会打乱客户购买,因此,接口只返回客户这个指定产品的详情和高佣推广链接。


【注意】

1、此时接口返回值和参数,与万能高佣转链接口hcapi一致。

2、您也可以指定 onlysearch 参数,强制使用该产品标题来搜索同类产品。但不建议这么做,可能会打乱客户购买决策。

3、此时如果商品是非淘宝联盟的商品,可以指定参数similar=1,则接口会使用它的标题去搜索相拟产品。


例1:搜索天猫指定产品:

http://api.veapi.cn/tbk/super?vekey=xxx&para=http://zmnxbc.com/s/YJk6Z

这个链接本身是从天猫APP中复制的(实际参数你可以直接把客户完整的内容传递给接口)。

这种情形下,super接口会直接识别出其中的产品,并转换成高佣转链功能,这时返回的结果不是产品列表,而是和hcapi高佣转链结果一样的返回值。

【特别说明】当super转换为转链功能时,它的参数和hcapi高佣接口功能一样。因此您可以用hcapi接口参数

但是,如果您想在客户搜索淘口令或链接时,也使用该商品标题搜索同类产品,那么可以指定 onlysearch 参数(参考下文参数说明) ,这时接口会用解析参数后的产品标题做关键字搜索。


例2:搜索产品并使用自动找相似功能:

http://api.veapi.cn/tbk/super?vekey=xxx&para=¥NchgbxBILRt¥&similar=1

指定参数similar=1后,当搜索参数para为指定产品并且非淘宝联盟的产品(没有佣金),这时接口会自动用这个产品的标题搜索,找出相似的产品。


三、超级搜索返回值:

超级搜索API接口做了大量优化,更优的排序,更深层的查询。

【重要:关于commission_rate佣金比率字段值不同的说明

接口返回值类型有2种:泛搜索和定向搜索,一定要看返回值search_type字段,返回值中search_type字段值为1时是泛搜索,2时是定向搜索(和万能转链hcapi接口一样)

(1)泛搜索:这时接口返回search_type=1,返回值字段佣金比率“commission_rate”需要除以100,比如5000表示50%。

(2)定向搜索:而如果搜索指定商品,此时search_type=2时,这时返回值中的commission_rate字段不需要除以100,是正常佣金百分值。如50.0表示50%


【关于帐号初级或中级导致的佣金率不一致问题】

问:为什么我用关键字调用搜索接口时,返回返回产品列表中某产品佣金率commission_rate, 和使用该产品的淘口令或链接做参数调用搜索或转链接口时,返回的commission_rate不一样?

答:因为搜索接口泛搜索时(即使用关键字搜索或非联盟商品找相似搜索),返回的产品列表是按“最高佣金”显示的,方便做返利型APP的在搜索列表展示中直接显示会员可取多少分佣。但是你能否拿到这个最高佣金,要按你的帐户级别,只有高级帐号才可以,如果是初级或中级帐号,就会显示的佣金比例比泛搜索低。所以,只要把帐号升级即可。

可委托本站升级,全过程需要3天时间。



搜索返回值详解如下:


1、若使用关键字搜索到商品列表,则返回结果列表。返回值(包含result_list字段):

使用场景:

(1)使用普通关键字搜索,比如“女装”。

(2)客户搜索的商品是非淘宝联盟的商品,也会转换为关键字搜索。

以下是此时返回值,返回值详情和字段含义 http://www.veapi.cn/taokelianmeng/201.html

{

    "error": "0",

    "msg": "查询成功!",

    "search_type": "1",  # 1表示搜索产品关键字,2表示转链

    "is_similar":"0",   # 是否找相似搜索:0-否;1-是,这时参数中产品不是联盟的产品,

    "is_splitWord":"1", #是否使用精准提取产品词功能:0表示没有。1-表示启用了精准提取产品词,这时是全串关键字找不到结果,触发提词搜索。2-表示从缓存中使用精准提取产品词,3-表示通过强制参数force_index启动提词功能

    "force_index":"1600738109_08b9a792d27"  #如果需要使用接口中forece_index参数,则必须用这里返回值做入参,让接口强制对关键字提词,此时is_splitWord值为3

    "total_results": "561",  #表示总数有561笔产品

    "result_list": [

            {

                "category_id": "50010421",

                "conpon_info": "满100元减10元",  //优惠券面额从这提取,格式固定是"满xx元减yy元"

                ...... //搜索产品字段

              }

         ]

}


2、产品定向搜索:

使用场景:

当参数是指定产品的ID、淘口令、链接,并且没有强制只搜索产品标题时(onlysearch参数为1)

返回值(search_type和 data 字段不同):

这时 data返回值和高佣转链返回值是一致的。


{

    "error": "0",

    "msg": "查询成功!本次搜索直接转链产品",

    "search_type": "2", # 1表示搜索产品关键字,2表示转链

    "is_similar":"0",   # 是否找相似搜索,在这里定向搜索时,本字段无意义。

    "result": 2,

    "data": {

        "category_id": "50013864",

         "conpon_info": "满100元减10元",  //优惠券面额从这提取,格式固定是"满xx元减yy元"

          .... //转链的各种值

     }

}


3、当没有返回值,或出错时,返回值如下:

{

    "error": "15",

    "msg": "50001: 淘宝服务器没有返回结果",

    "search_type": "1"

}



四、超级搜索接口的其它参数:

因为搜索API有以下两种功能(定向搜索和泛搜索),因此参数需要pid等,参数说明如下:


(1)当搜索接口super触发定向搜索的转链功能时,它的参数和万能转链接口一致,因此,需要提供pid等参数。详情参数http://www.veapi.cn/doc 

比较重要的有:

1、pid 参数: 必选,至少提供一个默认的PID参数,当搜索接口触发转链功能时,会用到。最好是渠道PID

2、relationId 参数:可选,当搜索接口触发转链时,此渠道ID参数将做为转链参数。

其它转链场景(返回值中search_type值为2)请参考万能转链接口hcapi的参数。


(2)当仅搜索产品列表时,此super接口参数如下(均为非必须参数)

1、page 参数:传递当前页码值。默认1.

2、pagesize 参数:传递每页最大显示数,默认15,最大值不要超过30.

3、force_index 参数:可选。强制使用标题提词功能(有需要时调用,不要高频使用,影响效率):有时关键词,比如“95%绒子羽绒被白鹅绒被蓬松羽绒被芯被子”淘宝官方返回全是不相关的宠物玩具等产品,维易接口已做了自动分析返回值,如果不符合自动用“标题提词”功能介入优化搜索,得到正确结果,但有时可能有的词仍然被分析方法漏掉,得到的仍是不准确的结果,这时你可以使用本参数,把相同关键字上次搜索结果的返回值中“force_index”值做为本参数入参,比如“force_index=1600740049_e1142230473”,这样就可以对“相同的关键词”强制使用标题提词功能。

      【注意】本参数不能直接使用,要依赖于上次搜索结果返回的force_index字段值,且有时效性。且关键字必须相同。

      【使用场景】你可以在你的APP上搜索结果列表上做一个“搜索不准确?”的提示功能,让用户按下后,把前一次的返回值中force_index做为API入参,重新请求一次接口,得到正确结果。

4、coupon 参数:当不传递coupon参数或coupon=0时,默认搜索包含无券产品,当传coupon=1时则搜索有券产品。


5、start_price 和 end_price 参数:start_price 指折扣价范围下限,end_price 指折扣价范围上限,单位:元

6、start_tk_rate 和 end_tk_rate 参数:end_tk_rate,淘客佣金比率上限,如:1234表示12.34%,start_tk_rate淘客佣金比率下限,注意是千位表示法,比如要限制佣金是10%,则start_tk_rate=1000而不是start_tk_rate=10

7、is_overseas 参数:是否海外商品,is_overseas=1 指定为海外产品。默认为否。

8、is_tmall 参数:是否商城商品,默认0(可选0或1),设为1表示商品是天猫商城商品,不设置或0表示不限制。

9、cat 参数: 淘宝分类类目ID,用,分割,最大10个,该ID可以通过taobao.itemcats.get接口获取到。当传递了cat参数时,可以不必使用para参数,比如:

       http://apis.vephp.com/super?vekey=xxxxx&cat=50011129


10、sort 参数:排序,默认 total_sales_des(销量降序),可选值如下:

        global (综合排序)

        tk_rate_des(淘客佣金比率降序), 

        tk_rate_asc(淘客佣金比率升序),  

        total_sales_des(销量降序,默认), 

        total_sales_asc(销量升序),  

        tk_total_sales_des(累计推广量降序), 

        tk_total_sales_asc(累计推广量升序),   

        tk_total_commi_des(总支出佣金降序), 

        tk_total_commi_asc(总支出佣金升序), 

        price_des(价格降序),

        price_asc(价格升序);


11、onlysearch 参数(强制仅使用搜索):可选,当指定 onlysearch=1 时,如果para参数是“淘口令、产品ID、二合一等各种淘宝链接”时,本接口默认是会直接把参数转入高佣API,得到该参数对应的产品推广详情和淘口令。但是指定“onlysearch=1”后,接口会把para参数中淘口令等解析后取得它对应的产品标题,并且它的标题去搜索,而不会进行高佣转链。

12、similar 参数:可选值0和1(默认值0),是指自动使用找相似功能。默认是不找相似。当搜索中指定该参数为1时,则自动在发现非联盟产品时使用找相似功能。这时,返回值中字段 is_similar 表示是否为相似搜索,is_similar值为1表示近似产品搜索。

13、search_item 参数,可选值0和1(默认值0),当提供本参数时,只查询para参数值中指定的商品ID信息,这此如果para参数是淘口令或链接等,接口会解析该口令或链接的对应商品ID,再输出商品信息。使用该参数时,等同于使用item_id 参数时查询结果,但使用本参数,则可以解析淘口令等非商品ID入参。示例:

       http://api.veapi.cn/super?vekey=xxx&para=$1PDhcFjOJTp$&search_item=1

14、ip 参数: 当需要限制包邮时,最好传递顾客的IP参数,比如:  ip=122.71.37.32 ,本参数最好和freeship一起使用。

15、freeship 参数:是否只查包邮产品,默认值不限。如果只想要包邮产品,可以传递freeship=1

16、npx 参数: 默认不设置。此参数指定牛皮癣程度,此参数影响主图美观度,可用取值范围:1-不限,2-无,3-轻微

17、item_id 参数,用于传递产品ID参数,当使用本参数时,para参数的如果是“关键词”搜索时将失效。接口返回该ID的产品信息。使用本参数时,onlysearch和similar同时失效。这时返回的是该ID的产品搜索结果,而非定向转链接口。

      如: http://api.veapi.cn/super?vekey=xxx&item_id=580716515146

18、virtual 参数,可选值0,1,2,用于指定是否过滤或检测虚拟类产品,苹果上架APP时需要用到,可临时开启,参数值:默认0表示不检查虚拟类商品,1表示检测并拒绝虚拟类商品搜索(此时接口error为91),2表示只检测不过滤,这时返回值中增加一个字段is_virtual(值0表示不是虚拟产品,1表示是虚拟产品)


【以下参数按需选用】

19、presale 参数(仅双11期间有效):默认不设置,可选值1或0,当设置为1时,使用关键字搜索的商品均为双11预售商品。

20、material_id 参数:可选,指定物料ID。当presale参数为1时,本参数失效。

21、include_pay_rate_30 参数(可选):参数值1或0,商品筛选(特定媒体支持)-成交转化是否高于行业均值。1表示大于等于,0或不设置表示不限

22、include_good_rate 参数(可选):参数值1或0,商品筛选-好评率是否高于行业均值。1表示大于等于,0或不设置表示不限

23、end_ka_tk_rate 参数(可选):商品筛选-KA媒体淘客佣金比率上限。如:1234表示12.34%

24、start_ka_tk_rate 参数(可选):商品筛选-KA媒体淘客佣金比率下限。如:1234表示12.34%

25、device_value 参数(可选):智能匹配-设备号加密后的值(MD5加密需32位小写)

26、device_encrypt  参数(可选):智能匹配-设备号加密类型:MD5

27、device_type  参数(可选):智能匹配-设备号类型:IMEI,或者IDFA,或者UTDID(UTDID不支持MD5加密),或者OAID

28、lock_rate_end_time  参数(可选):示例值:1567440000000,锁佣结束时间

29、lock_rate_start_time  参数(可选):示例值:1567440000000,锁佣开始时间

30、seller_ids  参数(可选):示例值“1,2,3,4”,商家id,仅支持饿了么卡券商家ID,支持批量请求1-100以内,多个商家ID使用英文逗号分隔

31、city_code  参数(可选):本地化业务入参-LBS信息-国标城市码,仅支持单个请求,请求饿了么卡券物料时,该字段必填。 (详细城市ID见:https://mo.m.taobao.com/page_2020010315120200508)

32、latitude  参数(可选):本地化业务入参-LBS信息-纬度,如31.230370

33、longitude  参数(可选):本地化业务入参-LBS信息-经度。如121.473701

34、relation_id  参数(可选):渠道关系ID,仅适用于渠道推广场景,如2566221

35、special_id 参数(可选):会员运营ID

36、need_prepay 参数(可选):参数值1或0,商品筛选-是否加入消费者保障。1表示加入,0或不设置表示不限

37、tklink 参数默认不设置,可选值1或0,返回的搜索结果直接带有您的推广链接。此时返回值的商品列表中,如果商品有券则多返回“coupon_share_url”(领券链接)和“url”(不领券但有佣金,直接跳到淘宝天猫),如果商品无券,则返回“url”链接。如果你同时传递relationId渠道ID参数,那么这两个链接会附加渠道ID值。


五、错误码:

具体错误码参考 http://www.veapi.cn/doc/taobaokeapijiekoucuowuma

在线
客服

会员请加QQ群交流:

微信
咨询

加微信咨询
顶部