正式文档列表
GET /apiv2/posts.json GET /apiv2/posts.json?sort=count_view:desc,id:asc
GET /apiv2/posts.json?start=2018-01-01&end=2018-01-05
查看草稿列表
GET /apiv2/posts/draft.json
查看指定文档分类的正式文档列表
GET /apiv2/forums/{forum_id}/posts.json GET /apiv2/forums/{forum_id}/posts.json?sort=count_view:desc,updated_at:desc
查看指定分区下的正式文档列表
GET /apiv2/categories/{category_id}/posts.json GET /apiv2/categories/{category_id}/posts.json?sort=id:desc
还可以调用下列API查看指定客服创建的正式文档:
GET /apiv2/users/{user_id}/posts.json GET /apiv2/users/{user_id}/posts.json?sort=count_view:desc,sort:desc
调用权限
all users
请求参数
filter:自定义筛选条件,可选, filter参数值需要做urlencode编码处理。格式为:'筛选字段:筛选值'。支持的筛选字段:
is_home,(是否推荐显示) is_highlight,(是否高亮) is_top,(是否置顶) is_dashboard,(是否在控制台首页显示)
不同的筛选条件用英文逗号隔开,示例:
GET /apiv2/posts.json?filter=is_home:0,is_top:1
sort:自定义组合排序规则,可选,格式为:'排序字段:排序方式'。支持的排序字段:
'id',(ID) 'created_at',(创建时间) 'updated_at',(更新时间) 'is_top',(是否置顶) count_view(浏览数) count_comments(评论数) sort(排序序号)
支持的排序方式:asc(升序), desc(降序),不同的筛选条件用英文逗号隔开,示例:
GET /apiv2/posts.json?sort=count_view:desc,updated_at:desc
start,end 文档的创建时间的开始范围和结束范围,请用2018-01-01格式
注意:如果某文档属于一个查看权限为客服的文档分类,则客户无法查看该文档
curl 示例
curl https://{subdomain}.kf5.com/apiv2/posts.json \ -v -u {email_address}:{password}
返回示例
Status: 200 OK{ "posts": [ { "id": 421, "title": "代理指南样本的测试", ... }, { "id": 425, "title": "帮助指南", ... } ]}