附录1-API接入-物料上传

1. 物料上传API

1.1 接口介绍

1)物料上传请求格式

① HTTP Method:POST

② URL:https://nbrecsys.4paradigm.com/business/items?accessToken={物料库的token}

③ Content-Type:application/json

④ Request Body:

  • 注意:物料上传单次不要超过100条
  • 举例:
[
    {
        "itemId":"12345678990",
        "title":"把培育时代新人的重任扛在肩上",
        "content":"作为教育者,必须时刻把准时代方向,摒弃一切不合时宜的思想,始终坚持“五育并举”“六个下功夫”的要求,树好新时代教师“四有”标准,积极承担学生健康成长“四个引路人”责任,坚持不懈培育和弘扬社会主义核心价值观与大力弘扬民族精神、时代精...",
        "url":"http://item.btime.com/45bruvk0pr98bk99gaplsh0uolm",
        "categoryId":"教育",
        "publishTime":1554274478000,
        "publisherId":"当代商报",
        "tag":"中小学,教育",
        "coverUrl":"http://p0.qhimg.com/t01debf66a8a2595437.png?size=306x212"
    },
        {
        "itemId":"0987654321",
        "title":"中民金融执行总裁郑理破题穿越周期之术,再进“虚拟经济”下一城",
        "content":"作为中民投集团在香港的重要境外战略平台,中民金融(00245)近来高调转型数字金融只是起跑的发令枪,正如其执行总裁郑理所言,“帮助一家公司从0到1不是中民金融的长项,我们擅长的是帮助其从10成长到100、甚至1000”。",
        "url":"http://item.btime.com/45i5lt7oe3082093s7vunc1psfd",
        "categoryId":"新闻",
        "publishTime":1554274947000,
        "publisherId":"港股挖掘机",
        "tag":"虚拟经济,中民,郑理,总裁",
        "coverUrl":"http://p4.qhimg.com/t013d042996144d68eb.jpg?size=1080x607"
    }
]

2)物料上传返回格式

① Return-Type:application/json

② Return Body:

  • 举例:
{
    "code": 200,
    "info": "成功",
    "data": null
}

1.2 Body字段介绍

1)物料上传请求Body

字段名称 字段类型 是否必传 释义 举例
itemId string 必传 物料有且唯一的ID。 2834716231
title string 必传 物料的标题。注意:如果不传该字段,会影响算法对物料的分析,从而降低推荐效果。 感动中国的大学生,今成副书记
content string 必传 物料的文本内容,例如 简介/摘要/正文。最长支持2000个字符,超长的部分会予以截断。注意:如果不传该字段,会影响算法对物料的分析,从而降低推荐效果。 生于1982年的徐本禹是山东聊城人,家境贫寒的他在华中农业大学读书期间
url string 必传 物料的链接地址。 http://www.pcUrl.com/xxx
categoryId string 非必传 物料的分类。注意:如果不传该字段,后续无法通过物料分类进行推荐或者进行过滤。 多级分类之间用英文逗号“,”进行分隔。例如1级分类——萌宠,2级分类——狗,则该字段的上传格式为“萌宠,狗”。1级分类之间用英文分号“;”进行分隔。如果某物料属于多个1级分类,例如既属于1级分类——萌宠,2级分类——狗,又属于1级分类——生物,2级分类——犬科,则该字段的上传格式为“萌宠,狗;生物,犬科”。
publishTime long 非必传 物料的发布时间。UNIX时间戳格式,必须精确到毫秒。注意:如果不传该字段,会影响算法对物料时效性的判断,从而降低推荐效果。 1522725647210
publisherId string 非必传 物料的发布者有且唯一的ID。注意:如果不传该字段,后续无法从发布者维度提供关联推荐。 范式推荐
isRecommend string 非必传 物料是否能被推荐。能被推荐则传"1",不能被推荐(即封禁)则传"0"。不传则默认能被推荐。注意:如果物料是封禁状态,为了解除封禁,需要去物料库手动关闭该物料的封禁开关,请见二、使用帮助 1
tag string 非必传 物料的标签。注意:该字段有助于提升推荐效果。 多个标签之间用英文逗号“,”进行分隔。例如“感动中国,官员”。
coverUrl string 非必传 物料的封面图的链接地址。 多个图片链接地址之间用英文分号“;”进行分隔。例如“https://bc1.jpg;https://ghj.jpg”。
score string 非必传 物料的权重。注意:如果不传该字段,或者传的是空,则默认为“0”。 权重的范围是-10~10的整数。数值越大,权重越高,反之亦然。例如“9”。
type string 非必传 物料的类型。注意:如果不传该字段,或者传的是空,则默认为“3”。 4
extra1 string 非必传 自定义字段1,长度为32位(中英文都只占1个字符)
extra2 string 非必传 自定义字段2,长度为32位(中英文都只占1个字符)
extra3 string 非必传 自定义字段3,长度为64位(中英文都只占1个字符)
extra4 string 非必传 自定义字段4,长度为2048位(中英文都只占1个字符)

2)物料上传返回Body

字段名称 字段类型 释义 举例
code int 状态码 200
info string 状态提示信息 成功
data 数组 如果出现url冲突的问题(即新物料与物料库中已有物料的url重复了),会在接口返回的data中展示冲突的url [{"物料库原itemId": "1234567","与现有物料冲突的url": "http://item.btime.com/99gaplsh0uolm"}]

3)type(类型)字段介绍

类型编号 类型(type)
1 话题
11 单话题
12 话题合集(由多个话题组成)
2 图片
21 单图
22 图集(由多张图片组成)
3 文章
31 纯文
32 图文(文字+图片构成的文章)
33 专题(由多个文章组成)
34 短图文(文字+图片构成的文章,字数一般不超过200字)
4 音频
41 长音频(>1分钟)
42 短音频(≤1分钟)
43 音频合集(由多段音频组成)
5 视频
51 长视频(>1分钟)
52 短视频(≤1分钟)
53 视频合集(由多段视频组成)
54 直播
55 小视频(≤15秒)

4)code(状态码)字段介绍

状态码(code) 状态提示信息(info) 备注
200 成功
3317 物料必须包含URL
3318 物料itemId不能为空
3320 物料一次操作不能超过100条
3322 上传物料不能为空
3323 物料集无效或者不存在
3332 该物料必须带有title
3334 物料key值不能为空
3338 物料本次上报与库中已有的url存在冲突 如果出现url冲突的问题,会在接口返回的data中展示冲突的url

1.3 代码示例

1)物料上传请求

curl -X POST 
        'https://nbrecsys.4paradigm.com/business/items?accessToken=1qaz2wsx3edc'  
        -H 'Content-Type: application/json'  
        -d '[
          {
              "itemId":"12345678990",
              "title":"把培育时代新人的重任扛在肩上",
              "content":"作为教育者,必须时刻把准时代方向,摒弃一切不合时宜的思想,始终坚持“五育并举”“六个下功夫”的要求,树好新时代教师“四有”标准,积极承担学生健康成长“四个引路人”责任,坚持不懈培育和弘扬社会主义核心价值观与大力弘扬民族精神、时代精...",
              "url":"http://item.btime.com/45bruvk0pr98bk99gaplsh0uolm",
              "categoryId":"教育",
              "publishTime":1554274478000,
              "publisherId":"当代商报",
              "tag":"中小学,教育",
              "coverUrl":"http://p0.qhimg.com/t01debf66a8a2595437.png?size=306x212"
          },
          {
              "itemId":"0987654321",
              "title":"中民金融执行总裁郑理破题穿越周期之术,再进“虚拟经济”下一城",
              "content":"作为中民投集团在香港的重要境外战略平台,中民金融(00245)近来高调转型数字金融只是起跑的发令枪,正如其执行总裁郑理所言,“帮助一家公司从0到1不是中民金融的长项,我们擅长的是帮助其从10成长到100、甚至1000”。",
              "url":"http://item.btime.com/45i5lt7oe3082093s7vunc1psfd",
              "categoryId":"新闻",
              "publishTime":1554274947000,
              "publisherId":"港股挖掘机",
              "tag":"虚拟经济,中民,郑理,总裁",
              "coverUrl":"http://p4.qhimg.com/t013d042996144d68eb.jpg?size=1080x607"
          }
      ]'

2)物料上传返回

{
    "code": 200,
    "info": "成功",
    "data": null
}

2. 物料更新API

2.1 接口介绍

1)物料更新请求格式

① HTTP Method:POST

② URL:https://nbrecsys.4paradigm.com/business/items/update?type={1|2}&accessToken={物料库的token}

③ Content-Type:application/json

④ Request Body:

  • 注意:物料更新单次不要超过100条

  • 举例:如果type等于1,

[
    {
        "itemId":"12345678990",
        "title":"把培育时代新人的重任扛在肩上",
        "tag":"中小学,教育"
    },
        {
        "itemId":"0987654321",
        "title":"中民金融执行总裁郑理破题穿越周期之术,再进“虚拟经济”下一城",
        "content":"作为中民投集团在香港的重要境外战略平台,中民金融(00245)近来高调转型数字金融只是起跑的发令枪,正如其执行总裁郑理所言,“帮助一家公司从0到1不是中民金融的长项,我们擅长的是帮助其从10成长到100、甚至1000”。"
    }
]

2)物料更新返回格式

① Return-Type:application/json

② Return Body:

  • 举例:
{
    "code": 200,
    "info": "成功",
    "data": null
}

2.2 Body字段介绍

1)物料上传返回Body

字段名称 字段类型 释义 举例
code int 状态码 200
info string 状态提示信息 成功
data 数组 null

2)code(状态码)字段介绍

状态码(code) 状态提示信息(info) 备注
200 成功
3317 物料url不能为空
3318 物料itemId不能为空
3320 物料一次操作不能超过100条
3323 物料集无效或者不存在
3334 物料key值不能为空

2.3 代码示例

1)物料更新请求

curl -X POST
        'https://nbrecsys.4paradigm.com/business/items/update?type=1&accessToken=1qaz2wsx3edc' 
        -H 'Content-Type: application/json' 
        -d '[
          {
              "itemId":"12345678990",
              "title":"把培育时代新人的重任扛在肩上",
              "content":"作为教育者,必须时刻把准时代方向,摒弃一切不合时宜的思想,始终坚持“五育并举”“六个下功夫”的要求,树好新时代教师“四有”标准,积极承担学生健康成长“四个引路人”责任,坚持不懈培育和弘扬社会主义核心价值观与大力弘扬民族精神、时代精...",
              "tag":"中小学,教育"
          },
          {
              "itemId":"0987654321",
              "title":"中民金融执行总裁郑理破题穿越周期之术,再进“虚拟经济”下一城",
              "content":"作为中民投集团在香港的重要境外战略平台,中民金融(00245)近来高调转型数字金融只是起跑的发令枪,正如其执行总裁郑理所言,“帮助一家公司从0到1不是中民金融的长项,我们擅长的是帮助其从10成长到100、甚至1000”。",
              "tag":"虚拟经济,中民,郑理,总裁"
          }
      ]'

2)物料更新返回

{
    "code": 200,
    "info": "成功",
    "data": null
}

3. 物料删除API

3.1 接口介绍

1)物料删除请求格式

① HTTP Method:POST

② URL:https://nbrecsys.4paradigm.com/business/items/remove?type={1|2}&accessToken={物料库的token}

③ Content-Type:application/json

④ Request Body:

  • 举例:如果type等于1,
[
    "12345678990",
    "0987654321"
]

2)物料删除返回格式

① Return-Type:application/json

② Return Body:

  • 举例:
{
    "code": 200,
    "info": "成功",
    "data": null
}

3.2 Body字段介绍

1)物料删除返回Body

字段名称 字段类型 释义 举例
code int 状态码 200
info string 状态提示信息 成功
data 数组 null

2)code(状态码)字段介绍

状态码(code) 状态提示信息(info) 备注
200 成功
3320 物料一次操作不能超过100条
3323 物料集无效或者不存在
3334 物料key值不能为空

3.3 代码示例

1)物料删除请求

curl -X POST  
        'https://nbrecsys.4paradigm.com/business/items/remove?accessToken={物料的token}&type=1'  
        -H 'Content-Type: application/json'  
        -d '["7f6dd2c62dd8677b4d42a617ee901871","d9004ddbffd85641170f97c95ecd8720"]'

2)物料删除返回

{
    "code": 200,
    "info": "成功",
    "data": null
}

4. 物料查询API

4.1 接口介绍

1)物料查询请求格式

① HTTP Method:POST

② URL:https://nbrecsys.4paradigm.com/business/items/search?type={1|2}&accessToken={物料库的token}

③ Content-Type:application/json

④ Request Body:

  • 举例:如果type等于1,
[
    "12345678990",
    "0987654321"
]

2)物料查询返回格式

① Return-Type:application/json

② Return Body:

  • 举例:
{
    "code":200,
    "info":"成功",
    "data":
    [
        {
            "itemId":"12345678990",
            "title":"把培育时代新人的重任扛在肩上",
            "content":"作为教育者,必须时刻把准时代方向,摒弃一切不合时宜的思想,始终坚持“五育并举”“六个下功夫”的要求,树好新时代教师“四有”标准,积极承担学生健康成长“四个引路人”责任,坚持不懈培育和弘扬社会主义核心价值观与大力弘扬民族精神、时代精...",
            "url":"http://item.btime.com/45bruvk0pr98bk99gaplsh0uolm",
            "categoryId":"教育",
            "publishTime":1554274478000,
            "publisherId":"当代商报",
            "tag":"中小学,教育",
            "coverUrl":"http://p0.qhimg.com/t01debf66a8a2595437.png?size=306x212",
            "isRecommend":"1",
            "score":"0",
            "type":"3",
            "extra1":"",
            "extra2":"",
            "extra3":"",
            "extra4":""
        },
        {
            "itemId":"0987654321",
            "title":"中民金融执行总裁郑理破题穿越周期之术,再进“虚拟经济”下一城",
            "content":"作为中民投集团在香港的重要境外战略平台,中民金融(00245)近来高调转型数字金融只是起跑的发令枪,正如其执行总裁郑理所言,“帮助一家公司从0到1不是中民金融的长项,我们擅长的是帮助其从10成长到100、甚至1000”。",
            "url":"http://item.btime.com/45i5lt7oe3082093s7vunc1psfd",
            "categoryId":"新闻",
            "publishTime":1554274947000,
            "publisherId":"港股挖掘机",
            "tag":"虚拟经济,中民,郑理,总裁",
            "coverUrl":"http://p4.qhimg.com/t013d042996144d68eb.jpg?size=1080x607",
            "isRecommend":"1",
            "score":"0",
            "type":"3",
            "extra1":"",
            "extra2":"",
            "extra3":"",
            "extra4":""
        }
    ]
}

4.2 Body字段介绍

1)物料查询返回body

字段名称 字段类型 释义 举例
code int 状态码 200
info string 状态提示信息 成功
data 数组 物料信息 [{"itemId":"12345678990","title":"把培育时代新人的重任扛在肩上","content":"作为教育者,必须时刻把准时代方向,摒弃一切不合时宜的思想,始终...","url":"http://uolm","categoryId":"教育","publishTime":1554274478000,"publisherId":"当代商报","tag":"中小学,教育","coverUrl":"http://5437.png","isRecommend":"1","score":"0","type":"3","extra1":"","extra2":"","extra3":"","extra4":""}]

2)code(状态码)字段介绍

状态码(code) 状态提示信息(info) 备注
200 成功
3320 物料一次操作不能超过100条
3323 物料集无效或者不存在
3334 物料key值不能为空

4.3 代码示例

1)物料查询请求

curl -X POST 
        'https://nbrecsys.4paradigm.com/business/items/search?accessToken={物料的token}&type=1' 
        -H 'Content-Type: application/json' 
        -d '["7f6dd2c62dd8677b4d42a617ee901871","d9004ddbffd85641170f97c95ecd8720"]'

2)物料查询返回

{
    "code":200,
    "info":"成功",
    "data":
    [
        {
            "itemId":"12345678990",
            "title":"把培育时代新人的重任扛在肩上",
            "content":"作为教育者,必须时刻把准时代方向,摒弃一切不合时宜的思想,始终坚持“五育并举”“六个下功夫”的要求,树好新时代教师“四有”标准,积极承担学生健康成长“四个引路人”责任,坚持不懈培育和弘扬社会主义核心价值观与大力弘扬民族精神、时代精...",
            "url":"http://item.btime.com/45bruvk0pr98bk99gaplsh0uolm",
            "categoryId":"教育",
            "publishTime":1554274478000,
            "publisherId":"当代商报",
            "tag":"中小学,教育",
            "coverUrl":"http://p0.qhimg.com/t01debf66a8a2595437.png?size=306x212",
            "isRecommend":"1",
            "score":"0",
            "type":"3",
            "extra1":"",
            "extra2":"",
            "extra3":"",
            "extra4":""
        },
        {
            "itemId":"0987654321",
            "title":"中民金融执行总裁郑理破题穿越周期之术,再进“虚拟经济”下一城",
            "content":"作为中民投集团在香港的重要境外战略平台,中民金融(00245)近来高调转型数字金融只是起跑的发令枪,正如其执行总裁郑理所言,“帮助一家公司从0到1不是中民金融的长项,我们擅长的是帮助其从10成长到100、甚至1000”。",
            "url":"http://item.btime.com/45i5lt7oe3082093s7vunc1psfd",
            "categoryId":"新闻",
            "publishTime":1554274947000,
            "publisherId":"港股挖掘机",
            "tag":"虚拟经济,中民,郑理,总裁",
            "coverUrl":"http://p4.qhimg.com/t013d042996144d68eb.jpg?size=1080x607",
            "isRecommend":"1",
            "score":"0",
            "type":"3",
            "extra1":"",
            "extra2":"",
            "extra3":"",
            "extra4":""
        }
    ]
}
Copyright ©2017 4Paradigm All Rights Reserved            文件修订时间: 2019-10-09 11:23:23

results matching ""

    No results matching ""