1. 背景
百家号为创作者提供自主开发接入百家号的方案,开发者可通过使用我们提供的接口服务,将图文、视频等内容接入至百家号平台内。
2. 使用对象
本接口服务适用于经过有效注册及申请后,以自身名义开发并对传输内容承担相应责任的开发者。
3. 开发流程与使用规范
3.1 开发流程
仔细阅读、同意并遵守百家号服务协议及开发者使用规范 —— 获取app_token及app_id —— API 对接 —— 接入内容至百家号平台内
3.2 使用规范
开发者在进行内容接入开发时,需要满足各个接口的规范限制,同时要注意传输内容符合百家号信息内容规范。
开发者在使用百家号接口文档时,所有使用方式必需按照文档中规定的方式使用,如有不明确之处,需要与百家号进行沟通;
接入文档中全部的接口,开发者只能在当前合作的内容传输方式中使用,不得通过任何方式提供给其他产品使用;
开发者获取到的app_token是调用百家号接口的关键凭证,开发者需妥善保管,若app_token泄露或丢失,需要在第一时间内进行重置;
开发者需传输符合百家号服务协议中的数据,为了保证用户体验,百家号会对其他平台的推广信息进行屏蔽;
开发者通过接口传输的数据遵循百家号的统一审核标准,百家号将主动拒绝不符合发布要求的内容;
开发者通过接口可推送的内容篇数受作者每日可发文篇数的统一限制;
4. 发布图文
4.1 接入流程
账号状态:发布图文内容的百家号账号状态正常
获取授权:同意开发者使用规范,获取app_token
创建文章:创建图文内容
调用接口:调用发布图文内容接口
4.2 接口地址
URL:http://baijiahao.baidu.com/builderinner/open/resource/article/publish
4.3 接口参数
参数名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
app_id | string | 是 | 作者帐号ID |
app_token | string | 是 | 授权密钥 |
title | string | 是 | 文章标题,限定8-40个中英文字符以内 |
content | string | 是 | 正文内容,限制20000个中英文字符内,富文本 |
origin_url | string | 是 | 原文地址 |
cover_images | json | 否 | 文章封面图片地址url, 0-3张封面图,封面图尺寸不小于218*146,可以为空,没有封面图的内容将会进入草稿 |
is_original | int | 否 | 标定是否原创,1 为原创,0 为非原创 |
4.4 注意
为了避免文章重复同步,百家号会做去重策略,相同文章禁止重复提交
4.5 返回值及解释
返回值 | 类型 | 描述 |
---|---|---|
errno | int | 错误码 |
errmsg | string | 错误信息 |
data | array | 返回数据 |
4.6 发布图文示例
4.7 返回值示例
5. 发布图集
5.1 接入流程
账号状态:发布图集内容的百家号账号状态正常
获取授权:同意开发者使用规范,获取app_token
创建文章:创建图集内容
调用接口:调用发布图集内容接口
5.2 接口地址
URL:http://baijiahao.baidu.com/builderinner/open/resource/article/gallery
5.3 接口参数
参数名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
app_id | string | 是 | 作者账号ID |
app_token | string | 是 | 授权密钥 |
title | string | 是 | 图集标题,限定8-40个中英文字符以内 |
photograph | json | 是 | 至少6张图片,desc描述为0-200个汉字;不支持GIF格式图片,发布GIF图将会被退回,且占用发文篇数;封面图尺寸不小于400*224;宽高比在0.5-2之间 |
origin_url | string | 否 | 图集资源原地址url |
publish_time | int | 否 | 原文发布时间,时间戳 |
5.4 注意
为了避免文章重复同步,百家号会做去重策略,相同文章禁止重复提交
5.5 返回值及解释
返回值 | 类型 | 描述 |
---|---|---|
errno | int | 错误码 |
errmsg | string | 错误信息 |
data | array | 返回数据 |
5.6 发布图集示例
5.7 返回值示例
6. 发布视频
6.1 接入流程
账号状态:发布视频内容的百家号账号状态正常
获取授权:同意开发者使用规范,获取app_token
创建文章:创建视频内容
调用接口:调用发布视频内容接口
6.2 接口地址
URL:http://baijiahao.baidu.com/builderinner/open/resource/video/publish
6.3 接口参数
参数名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
app_id | string | 是 | 作者帐号ID |
app_token | string | 是 | 授权密钥 |
title | string | 是 | 视频标题,限定 8-40 个中英文字符以内 |
video_url | string | 是 | 视频原地址,目前支持 mp4 等,不支持 m3u8 |
cover_images | string | 是 | 视频封面图片地址 url, 目前只支持 1 张图片作为封面,封面图尺寸不小于660*370 |
is_original | int | 否 | 标定是否原创,1 为原创,0 为非原创 |
use_auto_cover | int | 否 | 是否使用自动封面,1为使用自动封面,其余为不使用自动封面 |
tag | string | 否 | 视频tag,tag之间以半角英文逗号分割,每个tag长度不超过10个字符,最多支持10个tag |
6.4 注意
为了避免文章重复同步,百家号会做去重策略,相同文章禁止重复提交
6.5 返回值及解释
返回值 | 类型 | 描述 |
---|---|---|
errno | int | 错误码 |
errmsg | string | 错误信息 |
data | array | 返回数据 |
6.6 发布视频示例
6.7 返回值示例
7. 撤回内容
7.1 撤回内容API介绍
撤回API可对作者已发布的内容进行撤回,撤回后的文章将不再展示。
7.2 撤回流程
账号状态:发布内容的百家号账号状态正常
获取授权:同意开发者使用规范,获取app_token
文章状态:需要撤回的文章为作者已发布的文章,且状态为“已发布”
调用接口:调用撤回API接口
7.3 撤回接口地址
URL:http://baijiahao.baidu.com/builderinner/open/resource/article/withdraw
7.4 接口参数
参数名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
app_id | string | 是 | 作者账号ID |
app_token | string | 是 | 授权密钥 |
article_id | string | 是 | 需要撤回的文章ID |
7.5 返回值及解释
返回值 | 类型 | 描述 |
---|---|---|
errno | int | 错误码 |
errmsg | string | 错误信息 |
data | array | 返回数据 |
7.6 撤回内容示例
7.7 返回值示例
8. 修改图文
8.1 修改图文API介绍
修改API可对已撤回的图文进行修改,可修改标题、内容和封面图,修改成功后的文章将再次发布。对草稿状态的文章调用此API时,将会直接发布。
8.2 修改前提
需要修改的文章状态为“已撤回”
发布草稿时将占用当天发文次数
目前只能针对图文内容进行修改
8.3 修改流程
账号状态:发布内容的百家号账号状态正常
获取授权:同意开发者使用规范,获取app_token
文章状态:需要修改的文章已经撤回,状态为“已撤回”
调用接口:调用修改API接口
8.4 修改接口地址
URL:http://baijiahao.baidu.com/builderinner/open/resource/article/republish
8.5 接口参数
参数名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
app_id | string | 是 | 作者账号ID |
app_token | string | 是 | 授权密钥 |
title | string | 是 | 文章标题,限定8-40个中英文字符以内 |
content | string | 是 | 正文内容,限制20000个中英文字符内,富文本 |
cover_images | json | 是 | 文章封面图片地址url, 0-3张封面图,可以为空,没有封面图的内容将会进入草稿 |
article_id | string | 是 | 需要修改的文章ID |
origin_url | string | 是 | 原文地址 |
8.6 返回值及解释
返回值 | 类型 | 描述 |
---|---|---|
errno | int | 错误码 |
errmsg | string | 错误信息 |
data | array | 返回数据 |
8.7 修改图文示例
8.8 返回值示例
9. 错误码说明
errno | 说明 |
---|---|
0 | 成功 |
2 | 参数错误 |
4 | 数据库错误 |
5 | 数据库错误 |
60000005 | 账号未审核通过或在禁言期 |
60000006 | 百家号内部服务异常 |
60000009 | 账号不存在 |
60001001 | 授权校验失败 |
60001003 | 撤回或修改时文章状态错误 |
60001008 | 当天发文篇数校验失败 |
60001009 | 当天剩余发文篇数为0 |
60000020 | 百家号内部服务异常 |