YesApi 接口文档

8905 淘宝客-推广者-图文内容输出 App.Taobao_TaobaoTBK.ContentGet

接口路径(新):http://hn216.api.okayapi.com/api/App/Taobao_TaobaoTBK/ContentGet

接口路径(旧):http://hn216.api.okayapi.com/?s=App.Taobao_TaobaoTBK.ContentGet

接口描述: 淘客媒体内容输出。依赖于API文档/淘宝客API/taobao.tbk.content.get,使用前请先进行小白开放平台»设置»淘宝开放平台配置

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

特别注意:当前 hn216.api.okayapi.com 为临时接口测试域名!请先完成 绑定独立接口域名后 ,才能正式进行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字符串必须推广位,如:123。
如何找到推广位ID?
1.进入阿里妈妈后台>推广管理>推广位管理;2.在推广位管理 列表页 找到 PID,最后一个下划线后面的数字就是 推广位ID;一般PID的格式: mm_xxx_xxx_xxx 最后一个下划线就是推广位ID。例如对于推广位:mm_762460132_1145000489_109857350393,其推广位ID是:109857350393
type字符串可选1内容类型,1:图文、2: 图集、3: 短视频
before_timestamp字符串可选表示取这个时间点以前的数据,以毫秒为单位(出参中的last_timestamp是指本次返回的内容中最早一条的数据,下一次作为before_timestamp传过来,即可实现翻页)
count整型可选10表示期望获取条数
cid字符串可选类目
image_width字符串可选图片宽度,如:300
image_height字符串可选图片高度,如:300
content_set字符串可选默认可不传,内容库类型:1 优质内容

在线测试

参数是否必填
s 固定
uuid 可选
token 可选
return_data 可选
adzone_id 必须
type 可选
before_timestamp 可选
count 可选
cid 可选
image_width 可选
image_height 可选
content_set 可选

客户端请求示例

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

请求:
{你的接口域名}/?s=App.Taobao_TaobaoTBK.ContentGet&adzone_id=109857350393&type=1&count=2&app_key={你的app_key}&sign={动态签名}

返回:
{
    "ret": 200,
    "data": {
        "result": {
            "data": {
                "contents": {
                    "map_data": [
                    {
                        "author_avatar": "https://wwc.alicdn.com/avatar/getAvatar.do?width=160&height=160&type=sns&userId=3313869525",
                        "author_id": "3313869525",
                        "author_nick": "陈列师Asoka",
                        "clink": "//ifeeds.taobao.com/article.html?contentId=9562031&publishTime=1576072117000&pid=mm_762460132_1145000489_109857350393&source=default&union_lens=lensId:m_0b08381d_0b84_16ef53a634e_b155;traffic_flag:lm",
                        "content_categories": "[鞋包]",
                        "content_id": "9562031",
                        "images": {
                            "string": [
                                "https://ossgw.alicdn.com/union-content-cdn/055679c0db943124be7860733dee45d6.jpg?x-oss-process=image/resize,m_fill,w_300,h_300,limit_0",
                            "https://ossgw.alicdn.com/union-content-cdn/5f166a22da54388f9e5e4d227197fd5c.jpg?x-oss-process=image/resize,m_fill,w_300,h_300,limit_0",
                            "https://ossgw.alicdn.com/union-content-cdn/e26c5e32f0d23c35b3357b171f46a04b.jpg?x-oss-process=image/resize,m_fill,w_300,h_300,limit_0"
                                ]
                        },
                        "img_count": "3",
                        "item_ids": {
                            "number": "561472127984"
                        },
                        "publish_time": "1576072117000",
                        "score": "57",
                        "summary": "这个世界不是缺少美,而是缺少一双发现美的眼睛,这个世界不缺少好鞋,缺少的是认同它的主人。下面小编就为大家测评一款鞋子,带你发现它的美!这个世界不是缺少美,而是缺少一双发现美的眼睛,这个世界不缺少好鞋,缺少的是认同它的主人。下面小编就为大家测评一款鞋子,带你发现它的美!——鞋型——这款鞋子的鞋型是经典的 船型设计,是今年最流行的款式。微微翘起的鞋头,能够有效防止雨水打湿鞋子。——鞋后跟——这款鞋子的鞋后跟,是破跟的。鞋子从中部向后微微增高,有一种隐形的增高的功能。默默无闻中提升你的高度,增加你的气质美!——鞋内里——这款鞋子的鞋内里,是两层厚厚的猪皮材质,穿起来很柔软舒适,鞋子的鞋垫非常平坦,厚厚的材质有效的平整",
                        "tags": "[\"增高\", \"外穿\", \"女鞋\", \"经典\", \"包头半拖鞋\", \"平底凉鞋\", \"真皮女鞋\", \"拖鞋\", \"美的\", \"时尚凉拖\", \"夏季\"]",
                        "title": "用你能发现美的眼睛,看到这双鞋子的美!",
                        "type": "1",
                        "ui_style": "3",
                        "update_time": "1576072122000"
                    },
                    {
                        "author_avatar": "https://wwc.alicdn.com/avatar/getAvatar.do?width=160&height=160&type=sns&userId=3288428062",
                        "author_id": "3288428062",
                        "author_nick": "潮范儿",
                        "clink": "//ifeeds.tmall.com/article.html?contentId=9562033&publishTime=1576072118000&pid=mm_762460132_1145000489_109857350393&source=default&union_lens=lensId:m_0b08381d_0b84_16ef53a634e_b157;traffic_flag:lm",
                        "content_categories": "[男装]",
                        "content_id": "9562033",
                        "images": {
                            "string": [
                                "https://ossgw.alicdn.com/union-content-cdn/351de1be00893c7da33c9e3ee513b23a.png?x-oss-process=image/resize,m_fill,w_300,h_300,limit_0",
                            "https://ossgw.alicdn.com/union-content-cdn/c686023e4b573b008905dea21258e3b7.png?x-oss-process=image/resize,m_fill,w_300,h_300,limit_0",
                            "https://ossgw.alicdn.com/union-content-cdn/b4a65168a27231459dc3dacef86ace32.jpg?x-oss-process=image/resize,m_fill,w_300,h_300,limit_0"
                                ]
                        },
                        "img_count": "5",
                        "item_ids": {
                            "number": [
                                "594655534512",
                            "605589355374"
                                ]
                        },
                        "publish_time": "1576072118000",
                        "score": "58",
                        "summary": "直男们不会搭配怎么办?没关系,教你两个小技巧,让你轻松变身时尚型男。在大多数人的眼中,钢铁直男的穿搭总是遭人嫌弃,他们经常穿着千篇一律的T恤或者格子衬衫,再加上一个大裤衩和拖鞋,到了冬季,更是一件黑色羽绒服就解决所有搭配,经常看起来油腻腻的,简直惨不忍睹。 直男们不会搭配怎么办?是时候要改造自己了,不管从衣着还是配饰都需要的彻底的打造一番,这样才会让你改变直男形象。今天就跟大家分享一些变身型男的穿搭指南,让你变得更加帅气有型。 — ❶ — 学会叠穿技巧,增加穿搭层次感  很多直男穿搭之所以不美观,就是因为你不会搭配,卫衣,衬衫,羽绒服,牛仔裤,运动鞋等这些基础单品都有了,要怎么搭配才能提升自己的时尚感呢?可以",
                        "tags": "[\"男装\", \"卫衣\", \"外穿\", \"罗马\", \"毛衣\", \"羽绒服\", \"黑色羽绒服\", \"拖鞋\", \"牛仔裤\", \"缝线\", \"衬衫\", \"鸭舌帽\"]",
                        "title": "直男穿搭指南,两招让你变时尚型男",
                        "type": "1",
                        "ui_style": "3",
                        "update_time": "1576072122000"
                    }
                    ]
                },
                "count": "2",
                "last_timestamp": "1576072117000"
            }
        },
        "request_id": "4u6urqxobpyz"
    },
    "msg": "V1.3.13 小白开放接口 App.Taobao_TaobaoTBK.ContentGet"
}

接口返回及数据结构

返回字段类型说明
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万次接口流量奖励。