YesApi 接口文档

8906 淘宝客-推广者-物料搜索 App.Taobao_TaobaoTBK.MaterialOptional

接口路径(新)：http://api.yesapi.cn/api/App/Taobao_TaobaoTBK/MaterialOptional

接口路径(旧)：http://api.yesapi.cn/?s=App.Taobao_TaobaoTBK.MaterialOptional

接口描述： 通用物料搜索API（导购）。依赖于API文档/淘宝客API/taobao.tbk.dg.material.optional，使用前请先进行小白开放平台»设置»淘宝开放平台配置。在线演示请访问：开发者必备零食。

接口标签：免费(每月最高10万次)付费(包月/按量/私服)验签

特别注意：当前 api.yesapi.cn 为临时接口测试域名！请先完成 绑定独立接口域名后 ，才能正式进行API调用。

接口流量
1
请求协议
HTTP/HTTPS
请求方式
GET/POST（推荐POST）
编码格式
UTF-8
返回格式
JSON

在线测试接口    收藏此接口    在线接口开发    接口请求日记


接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；
  • return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
adzone_id字符串必须推广位，mm_xxx_xxx_12345678三段式的最后一段数字，如：123。
如何找到推广位ID？
1.进入阿里妈妈后台>推广管理>推广位管理；2.在推广位管理 列表页 找到 PID，最后一个下划线后面的数字就是 推广位ID；一般PID的格式: mm_xxx_xxx_xxx 最后一个下划线就是推广位ID。例如对于推广位：mm_762460132_1145000489_109857350393，其推广位ID是：109857350393
q字符串可选商品筛选-查询词
page_no字符串可选页码从1开始
page_size整型可选50页数，最大1000

在线测试

参数是否必填值
s 固定
uuid 可选
token 可选
return_data 可选
adzone_id 必须
q 可选
page_no 可选
page_size 可选

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

HTTP通用示例 
请求：
{你的接口域名}/?s=App.Taobao_TaobaoTBK.MaterialOptional&adzone_id=109856150478&q=办公零食&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "result_list": {
            "map_data": [
            {
                "category_id": "50010535",
                "category_name": "膨化食品",
                "commission_rate": "1200",
                "commission_type": "MKT",
                "coupon_amount": "10",
                "coupon_end_time": "2019-12-11",
                "coupon_id": "ac67637c5849492d8b7c4bc617b29842",
                "coupon_info": "满24.00元减10元",
                "coupon_remain_count": "99951",
                "coupon_share_url": "//uland.taobao.com/coupon/edetail?e=d5aBXBtzNVUNfLV8niU3RwXoB%2BDaBK5LQS0Flu%2FfbSp4QsdWMikAalrisGmre1Id522H2TxuqpK633e15CyRC4UpsKtpxCuLSfYLHfEjG8tdvWkO4mdSTvgBM2nGyWCJxDqyJAdxa%2FJRGqF5vmpvyEGMB05DMYU0LW0cp9rhR3NWbgkOnM3%2FTe5aRxmP7KyPsYDW%2FeIv9KTV8CKoRNyLdufVqn5cxLzlzWuH7hCAmylMDQVG07AK7A%3D%3D&&app_pvid=59590_11.132.118.138_473_1576074362441&ptl=floorId:2836;app_pvid:59590_11.132.118.138_473_1576074362441;tpp_pvid:100_11.178.158.87_18370_7811576074362444704&xId=FasZRPUTmiALycx302MHk7Ovzf1NgddC7ghE1KCbDX8VMz4wFBhFUA9IryW8j0ObebqA5oclKgSCC9gXIZtoOS&union_lens=lensId%3A0b84768a_af81_16ef55a3ea8_cb21",
                "coupon_start_fee": "24.00",
                "coupon_start_time": "2019-12-10",
                "coupon_total_count": "100000",
                "include_dxjh": "true",
                "include_mkt": "true",
                "info_dxjh": "{}",
                "item_description": "厂家直发 日期新鲜 鲜虾肉片",
                "item_id": "603951222167",
                "item_url": "https://detail.tmall.com/item.htm?id=603951222167",
                "level_one_category_id": "50002766",
                "level_one_category_name": "零食/坚果/特产",
                "nick": "喜盈盈旗舰店",
                "num_iid": "603951222167",
                "pict_url": "https://img.alicdn.com/bao/uploaded/i4/2378881695/O1CN01ETmEP91OOLuLilRyG_!!0-item_pic.jpg",
                "provcity": "河南 漯河",
                "real_post_fee": "0.00",
                "reserve_price": "45",
                "seller_id": "2378881695",
                "shop_dsr": "48647",
                "shop_title": "喜盈盈旗舰店",
                "short_title": "喜盈盈一口虾虾酥条办公室下午茶*",
                "small_images": {
                    "string": [
                        "https://img.alicdn.com/i4/2378881695/O1CN0187Rh6o1OOLtwLSZ2x_!!2378881695.jpg",
                    "https://img.alicdn.com/i2/2378881695/O1CN01jddxVb1OOLtHFL0kG_!!2378881695.jpg",
                    "https://img.alicdn.com/i1/2378881695/O1CN01uSdcko1OOLtIgkeOK_!!2378881695.jpg",
                    "https://img.alicdn.com/i2/2378881695/O1CN01VjAIhV1OOLte8HdSz_!!0-item_pic.jpg"
                        ]
                },
                "title": "喜盈盈一口虾虾酥条 办公室下午茶休闲零食薯条/鲜虾条80g*3大包",
                "tk_total_commi": "9117.93",
                "tk_total_sales": "2444",
                "url": "//s.click.taobao.com/t?e=m%3D2%26s%3DlimQQ5ZkwJMcQipKwQzePOeEDrYVVa64r4ll3HtqqoxyINtkUhsv0EJ%2FcETqmSLTyMJK2z9CSAMLen%2BMlB%2BBT%2B1HfCZxdJPDb9tkn%2F1u6KYYZQ6g3qfmcqwAREUZrIer1GPduzu4oNrtUmQdQKfdNMpMmMAKX8uYotYzDcQ4SzJrgjAxE6YN4uMeootrswwp9bWveRt%2BG4P9pElIsXItYeLNb4tvRpoZIYULNg46oBA%3D&scm=null&pvid=100_11.178.158.87_18370_7811576074362444704&app_pvid=59590_11.132.118.138_473_1576074362441&ptl=floorId:2836;originalFloorId:2836;pvid:100_11.178.158.87_18370_7811576074362444704;app_pvid:59590_11.132.118.138_473_1576074362441&xId=FasZRPUTmiALycx302MHk7Ovzf1NgddC7ghE1KCbDX8VMz4wFBhFUA9IryW8j0ObebqA5oclKgSCC9gXIZtoOS&union_lens=lensId%3A0b84768a_af81_16ef55a3ea8_cb21",
                "user_type": "1",
                "volume": "3150",
                "white_image": "https://img.alicdn.com/bao/uploaded/O1CN01F4HXXL1OOLtPlRGgK_!!2-item_pic.png",
                "x_id": "FasZRPUTmiALycx302MHk7Ovzf1NgddC7ghE1KCbDX8VMz4wFBhFUA9IryW8j0ObebqA5oclKgSCC9gXIZtoOS",
                "zk_final_price": "24.9"
            }
            ]
        },
        "total_results": "147367",
        "request_id": "4ctcwhh3lbfy"
    },
    "msg": "V1.3.13 小白开放接口 App.Taobao_TaobaoTBK.MaterialOptional"
}

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_code整型操作码，0表示成功，正数表示业务失败场景，负数表示系统失败场景
data.err_msg字符串错误提示信息，err_code非0时参考此提示信息
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

ret异常错误码

错误码错误类型错误描述信息解决方法
ret = 200成功请求成功
ret = 400客户端非法请求非法请求，参数错误1、根据接口文档的接口参数，提供正确的参数
ret = 401客户端非法请求用户未登录，或登录凭证已过期1、如果用户未注册，请先用注册接口；2、如果注册未登录或会话过期，请先用登录接口
ret = 402客户端非法请求IP已被黑名单拦截1、进入接口IP设置，移除IP黑名单设置
ret = 403客户端非法请求IP未命中白名单1、进入接口IP设置，添加IP白名单设置，或清空IP白名单设置
ret = 404客户端非法请求接口服务不存在1、查看小白接口大全，确保接口服务名称拼写正确
ret = 406客户端非法请求非法app_key，请核对你所在的接口域名1、在我的套餐查看并核对接口域名
ret = 407客户端非法请求当前应用已过期1、进行续费或续约，延长应用有效期
ret = 408客户端非法请求当前应用存在异常，已被封号1、联系在线客服人工处理（系统升级维护中，或 应用存在异常已被平台封号）
ret = 409客户端非法请求签名错误1、使用在线测试，校正签名；2、关闭特定或全部签名设置；3、如果过期，可以进行续约/升级
ret = 410客户端非法请求权限不足，非系统管理员1、应用权限不足，可联系在线客服咨询沟通
ret = 411客户端非法请求权限不足，应用管理员未登录1、请提供应用管理员的admin_uuid和admin_token参数后重试
ret = 412客户端非法请求权限不足，非应用管理员1、请在果创云把会员设置为管理员
ret = 413客户端非法请求本月接口流量超出，已被临时冻结1、开通接口流量叠加包，或升级套餐
ret = 414客户端非法请求并发过高1、请降低请求频率，检测是否有死循环调用，或是否被他人恶意使用。如果流量确实很大，可联系在线客服进行定制化或私有云部署。
ret = 415客户端非法请求接口已被开发者关闭1、接口已被开发者关闭，请进入果创云接口开关重新开启
ret = 416客户端非法请求权限不足，个人免费版套餐无法使用专业版接口1、请先升级终身会员/标准版/旗舰版/企业版
ret = 417客户端非法请求子应用异常，如：子应用签名错误/已过期/流量不足1、使用主账号在管理和配置 客户端/子应用
ret = 500小白接口异常如果出现此错误，请联系技术人员处理1、进入QQ交流群897815708，反馈问题；2、或者提交工单，一天内回复

常见问题FAQ

Q1 问：出现 414 Request-URI Too Large 时怎么解决？答：对于全部参数，改用POST方式传递，并且从GET链接里面去掉。

Q2 问：浏览器请求和在线测试接口正常，但本地程序无法正常获取接口结果。答：需要注意UTF编码，以及存在中文和特殊字符时的URL编码。GET请求参数应统一进行URL编码后再请求，POST表单数据正常传递即可。

Q3 问：请求接口时提示JSON格式错误。答：请先阅读，然后检测本地传递的参数是否符合JSON格式，使用JSON在线工具辅助检测，注意双引号和特殊符号。确认无误后再重新请求API接口。

Q4 问：出现 405 不允许跨域请求 时怎么办？答：可以追加GET参数 &yesapi_allow_origin=1，或参考用反向代理解决跨域问题等3种解决方案。

Q4 问：在wx内无法访问yesapi.cn或okayapi.com域名，怎么办？答：由于曾经短链跳转使用被wx误封域名，可以帮忙进行申诉。申诉后截图联系我们，获取15万次接口流量奖励。

特别注意：当前 api.yesapi.cn 为临时接口测试域名！请先完成 绑定独立接口域名后 ，才能正式进行API调用。

由 果创云YesApi.cn 提供技术支持，4万+开发者都在用，累计API调用1,800,000＋万次