编++公共接口协议标准版


版本历史

日期 版本 描述 作者
2018-03-07 1.0 初稿 韩辉
2019-08-19 1.1 增加teamId字段返回 赵琛

服务器地址

线上:api.zhihuibian.com

Demo帐号

appId:bjjapidemo

secret:53173b5e-eda0-4a42-8c41-913a3b812f8a

请求数据格式

协议采用http发送,请求使用rest风格

请求

请求时共有以下几个参数

其中secret是与账号绑定的密码,data是utf-8格式

返回正常数据

{
    status: int,    // 200. 成功
    ...             // 其它需要返回的数据
}

返回错误数据

返回

{
    status: int,            // 200. 成功, 400. 错误请求 401. 未授权 500. 内部错误
    errorId: long,          // 只有发生错误的时候存在该参数
    errorMsg: "错误描述信息"
}

时间格式

接口的返回的时间,包括请求的参数,均使用自1970年1月1日0时0分0秒开始的毫秒数。

接口分类

类别 编++功能模块 描述
采编类 自动采编 编++自动采编模块的对接接口,主要完成推送新闻对接

采编类接口

1. 获取已推送新闻

1.1 查询推送的新闻数据列表

请求

url: openapi/newsPush

demoUrl: http://apitest.zhihuibian.com/openapi/demo/newsPush

method: GET

{

}

返回

{
    status: int
    list:[
            {
                newsId: String,          //'新闻ID'
                teamId: String,          //'分组ID'
                title:String,           //'新闻标题'
                source: String,          //'来源'
                author: String,          //'作者'
                keywords: String,        //'关键字,用空格隔开'
                url: String,             //'原始链接'
                content: String,         //'新闻内容(后期会根据实际需求调整)'
                contentAbstract: String, //'摘要'
                publishTime: Long,       //'发布时间'
                createTime: long,        //'推送时间
            },...
    ]
}

例:{ "list":[ { "publishTime":1517468272000, "newsId":"98c6aff6984280e0edfa313551e43534", "teamId":"19", "contentAbstract":"人民日报50秒前来自新媒体聚合平台", "createTime":1517468324277, "author":"", "source":"人民日报", "title":"中国考古学泰斗宿白先生今早逝世", "keyword":"宿白,考古,今早,考古系,先生,", "url":"http://weibo.com/2803301701/G16oboNYr", "content":"人民日报 50秒前来自新媒体聚合平台【转发送别!中国考古学泰斗宿白先生今早逝世】今早6时05分,宿白先生病逝,享年96岁。宿白是中国佛教考古和新中国考古教育开创者,曾任北大考古系第一任系主任.........>" }, { "publishTime":1517462401000, "newsId":"198ae32f29839bfce259d55629011537", "teamId":"19", "contentAbstract":"人民日报2分钟前来自新媒体聚合平台", "createTime":1517462528208, "author":"", "source":"人民日报", "title":"贵州六盘水发生煤气中毒事件致9人死亡", "keyword":"六盘水,锅炉检修,贵州,煤气,发电机组,", "url":"http://weibo.com/2803301701/G15KGjiZo", "content":"人民日报 2分钟前来自新媒体聚合平台【贵州六盘水发生煤气中毒事件致9人死亡】据新华社,31日1......>" } ], "status":200 }

1.2 确认已处理新闻

当1.1 接口中新闻收到后,调用此接口,当再次调用1.1接口时,已确认处理完的新闻将不再显示

请求

url: openapi/newsPush

demoUrl: http://apitest.zhihuibian.com/openapi/demo/newsPush

method: DELETE

{
    newsIds: String //newsIds是一个逗号分隔的新闻id
}

例:{"newsIds":"2336a53ef47e2cedbd8b4f57cccc4674,e7abbec3cf3039b0eb363e435b15682a"}

返回

{
    status: int //状态 200 成功
}

例:{"status":200}