接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小：32 | 公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。 | |
| sign | 字符串 | 可选 | 公共参数接口签名，其中： | ||
| uuid | 字符串 | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构，其中：
| |
| num_iid | 整型 | 必须 | 商品Id | ||
| fields | 字符串 | 可选 | num_iid,title,pict_url,small_images,reserve_price,zk_final_price,user_type,provcity,item_url,nick,seller_id,volume | 需返回的字段列表 | |
| count | 整型 | 可选 | 20 | 最大：40 | 返回数量，默认20，最大值40 |
| platform | 整型 | 可选 | 1 | 最小：1；最大：2 | 链接形式：1：PC，2：无线，默认：１ |
在线测试
| 参数 | 是否必填 | 值 |
|---|---|---|
| s | 固定 | |
| uuid | 可选 | |
| token | 可选 | |
| return_data | 可选 | |
| num_iid | 必须 | |
| fields | 可选 | |
| count | 可选 | |
| platform | 可选 |
客户端请求示例
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求：
{你的接口域名}/?s=App.Taobao_TaobaoTBK.ItemRecommendGet&num_iid=558600578230&fields=num_iid,title,pict_url,small_images,reserve_price,zk_final_price,user_type,provcity,item_url,nick,seller_id,volume&count=3&platform=1&app_key={你的app_key}&sign={动态签名}
返回：
{
"ret": 200,
"data": {
"results": {
"n_tbk_item": [
{
"item_url": "http://item.taobao.com/item.htm?id=582886688469",
"nick": "fakeface旗舰店",
"num_iid": "582886688469",
"pict_url": "https://img.alicdn.com/tfscom/i1/1706206619/O1CN01eL14BS1ylY8KtPvB1_!!1706206619-0-pixelsss.jpg",
"provcity": "广东 深圳",
"reserve_price": "25.00",
"seller_id": "1706206619",
"small_images": {
"string": [
"https://img.alicdn.com/tfscom/i4/1706206619/O1CN01Uqod2i1ylY7ZPzCMy_!!1706206619.jpg",
"https://img.alicdn.com/tfscom/i2/1706206619/O1CN01SW7zgw1ylY2mfuN6W_!!1706206619.jpg",
"https://img.alicdn.com/tfscom/i3/1706206619/O1CN01hDpZjp1ylY2YdCYEP_!!1706206619.jpg",
"https://img.alicdn.com/tfscom/i2/1706206619/O1CN011ylY12qHW9CEAvY_!!1706206619.jpg"
]
},
"title": "Fakeface卸妆棉卸妆用脸部清洁湿敷厚款双面纯棉化妆棉女200片",
"user_type": "1",
"volume": "17561",
"zk_final_price": "9.90"
},
{
"item_url": "http://item.taobao.com/item.htm?id=583405411993",
"nick": "健美创研旗舰店",
"num_iid": "583405411993",
"pict_url": "https://img.alicdn.com/tfscom/i1/2258006982/O1CN01ewXpN221Rnu4otDIy_!!0-item_pic.jpg",
"provcity": "浙江 金华",
"reserve_price": "48.00",
"seller_id": "2258006982",
"small_images": {
"string": [
"https://img.alicdn.com/tfscom/i3/2258006982/O1CN01hAdWsy21Rnu2D9jDg_!!2258006982.jpg",
"https://img.alicdn.com/tfscom/i4/2258006982/O1CN01UZsxHr21RnqxQddsF_!!2258006982.jpg",
"https://img.alicdn.com/tfscom/i2/2258006982/O1CN01FjmnA221RnsIlYUEG_!!2258006982.jpg",
"https://img.alicdn.com/tfscom/i2/2258006982/O1CN01azVLJt21Rnqmd6wuP_!!2258006982.jpg"
]
},
"title": "健美创研洗脸巾女纯棉一次性洗面擦脸洁面巾美容专用卸妆棉化妆棉",
"user_type": "1",
"volume": "307222",
"zk_final_price": "8.10"
},
{
"item_url": "http://item.taobao.com/item.htm?id=558522738825",
"nick": "acare大陆直营店",
"num_iid": "558522738825",
"pict_url": "https://img.alicdn.com/tfscom/i1/1788211453/TB2uT0VXkZmBKNjSZPiXXXFNVXa_!!1788211453.jpg",
"provcity": "北京",
"reserve_price": "22.94",
"seller_id": "1788211453",
"small_images": {
"string": [
"https://img.alicdn.com/tfscom/i3/1788211453/O1CN01TlwpW31MbVzyoyhfm_!!1788211453.jpg",
"https://img.alicdn.com/tfscom/i3/1788211453/O1CN01xvdgoE1MbVyKWjIH4_!!1788211453.jpg",
"https://img.alicdn.com/tfscom/i1/1788211453/O1CN01PMqjYh1MbVyNdOLii_!!1788211453.jpg",
"https://img.alicdn.com/tfscom/i3/1788211453/O1CN01YM5lEP1MbVyFzPoWh_!!1788211453.jpg"
]
},
"title": "化妆棉盒装1000片纯棉卸妆棉脸部湿敷专用爽肤水厚薄款单层一次性",
"user_type": "0",
"volume": "1318",
"zk_final_price": "8.99"
}
]
},
"request_id": "ro291pqoztem"
},
"msg": "V1.3.8 小白开放接口 App.Taobao_TaobaoTBK.ItemRecommendGet"
}
接口返回及数据结构
| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码 |
| data | object/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万次接口流量奖励。