基础参数
参数 | 必选 | 类型 | 名称 | 说明 |
---|---|---|---|---|
client_id | 是 | string | 客户应用id | 从上一步对接指南获取 |
nonce_str | 是 | string | 安全随机字符串 | 当前时间戳(秒),10分钟内有效期 |
sign | 是 | string | 安全签名 | 见下一节 |
安全签名规则:
(1) 将所有请求参数,按参数名key,ASCII码正序,不包括 sign 和 client_secret,形如:
[
"client_id":"4fiodcz8xjl6p8nbzfex2",
"keyword":"云南",
"nonce_str":"1473820208"
]
(2) 进行 URL 编码,生成字符串,形如:
client_id=4fiodcz8xjl6p8nbzfex2&keyword=云南&nonce_str=1473820208
(3) 在末尾拼接上应用密钥(即client_secret),形如:
client_id=4fiodcz8xjl6p8nbzfex2&keyword=云南&nonce_str=1473820208&client_secret=9b530aa85723c06a90879bee8f5096d7
(4) 最后计算字符串的 MD5 哈希值,得到 32 位小写的安全签名,形如:
00ba2da066957662f43b668cf208e827
响应数据,基本以 JSON 格式返回,文件会以 FILE 格式返回。
请求失败的响应范例:
{
"result": false,
"message": '失败原因',
"code": 1001
}
请求成功的响应范例
{
"result": true,
"data": {}
}
为了更高效地对接,我们提供了 Java、Go 和 PHP 三种语言的 SDK 示例(软件开发工具包),建议您参考使用。
同时,我们也会准备相应的 Postman 调试配置,配合 nonce_str、sign 的10分钟有效期,方便您快速调试。
敬请期待
1. 购买获取的图片有尺寸限制吗,可以获得更大的尺寸吗?
购买图片API返回的尺寸是由商务谈定的,如需调整需要与商务联系协商。
2. 购买使用的 permission_id 如何获取?
您可以通过调用图片详情API来查询对应图片的 permission_id。
3. 为什么有时候通过图片名称搜索不出匹配名称的图片,怎样进行搜索?
1、图片搜索与文章咨询不同,它基于图片转文字算法生成n多个匹配标签,并不是以图片标题为唯一的检索依据。因此,当您尝试使用部门名称等文字内容无法检索到图片时,建议尝试使用图片元素作为关键字,例如颜色、形状和环境中的物品等,并在搜索框中输入这些关键词。请注意,搜索关键字应拆分成多个单独的单词,不支持短语搜索。
2、要进行高级的条件搜索,可以使用 and、or、not 和() 组合连接多个关键字,达到使用逻辑语句查询的高级功能。
4.热门排序是否基于全部图片进行排序?
不是。热门排序仅展示具有热度值的图片,而并非所有图片都有热度值。
5. preview_url 和 preview260_url 有什么区别?
preview_url 有水印,最大宽为450像素的缩略图,通常用作瀑布流展示。
preview260_url 无水印,最大高为260像素的缩略图,通常用作列表展示。
6. 搜索图片返回的链接过期时间是多久?
10分钟。
接口地址 video/search
请求方法 GET
参数列表
参数名 | 必填 | 类型 | 说明 |
---|---|---|---|
keyword | 否 | string | 查询的关键字 |
page | 是 | int | 哪一页 |
per_page | 否 | int | 每页数量 最大值 100 |
resolution | 否 | string | 分辨率:全部为空. 值为:4k, standard_definition, high_definition |
people_model_released | 否 | int | 是否含有肖像权。是传 1 |
start_duration | 否 | int | 时长区间开始 |
end_duration | 否 | int | 时长区间结束 |
返回结果
{
"result": true,
"data": {
"per_page": 100, //每页数量
"total": 10763, //总数量
"list": [
{
"id": "3633761",
"aspect": 1.778,
"duration": 20,
"description": "Blueberries with water droplets falling down in front of blurry background. Slow motion CG animation.",
"preview_jpg_url": "http://ak9.picdn.net/shutterstock/videos/3633761/thumb/1.jpg",
"preview_mp4_url": "http://47.88.150.139/ak9/shutterstock/videos/3633761/preview/stock-footage-blueberries-with-water-droplets-falling-down-in-front-of-blurry-background-slow-motion-cg.mp4",
"thumb_mp4_url": "http://47.88.150.139/ak3/shutterstock/videos/13949588/thumb/stock-footage-creative-business-team-meeting-in-modern-start-up-office-female-team-leader-pointing-at-screen.mp4"
},
]
}
}
接口地址 video/detail
请求方法 GET
参数列表
参数名 | 必填 | 类型 | 说明 |
---|---|---|---|
video_id | 是 | string | 视频 ID |
返回结果
{
"result": true,
"data": {
"video": {
"id": 16444624,
"title": "Daughter rushes into mother's arms at home and gives her a big hug. Shot on RED EPIC Cinema Camera in slow motion.",
"keywords": [
"卡哇伊",
"可愛",
"可爱",
"亲情",
"喜愛",
"喜爱",
"恩情",
"情义",
"情意",
"情爱",
"慈愛",
"慈爱",
"爱"
],
"aspect": "1.778",
"duration": 51, //时间 秒
"aspect_ratio": "16:9", // 纵横比率
"has_model_release" : true, // 肖像权
"has_property_release" : true, // 物权
"is_editorial" : true, //是否编辑用途 1是 0否
"preview_mp4_url": "http://47.88.150.139/ak8/shutterstock/videos/16444624/preview/stock-footage-daughter-rushes-into-mother-s-arms-at-home-and-gives-her-a-big-hug-shot-on-red-epic-cinema-camera.mp4", //mp4
"shutter_video_category_ids": [
"13",
"18"
],
"preview_jpg_url": "http://il5.picdn.net/shutterstock/videos/16444624/thumb/12.jpg",
"thumb_mp4_url": "http://47.88.150.139/ak8/shutterstock/videos/252217/thumb/stock-footage-hot-air-balloon-takes-flight.mp4"
},
"author": "Meloyan Media House",
"permissions": [ //权限
{
"id": 1016,
"name": "HD",
"size": "508.3MB",
"price": "2000",
"text": "1920x1080@25fps",
"asset_type": 'hd',
"format": "mov"
}
]
}
}
接口地址 video/purchase
请求方法 POST
参数列表
参数名 | 必填 | 类型 | 说明 |
---|---|---|---|
video_id | 是 | string | 视频 ID |
permission_id | 是 | int | 权限 ID |
warrant_name | 是 | string | 授权用户名称 |
third_user_id | 否 | string | 第三方用户 ID |
返回结果
{
"result": true,
"data": {
"id": 52, //购买ID
"url": "http://download.hellorf.com/hellorf/6b/0f/be36d08b8498c9a619608c089115/hellorf_2234567973.mov" //下载地址
}
}
接口地址 video/topic-categories
请求方法 GET
参数列表
参数名 | 必填 | 类型 | 说明 |
---|
{
"result": true,
"data": [
{
"id": 1022,
"name": "生活",
},
{
"id": 1023,
"name": "设计素材",
},
{
"id": 1028,
"name": "人物",
},
]
}
接口地址 video/topics
请求方法 GET
参数列表
参数名 | 必填 | 类型 | 说明 |
---|---|---|---|
category_id | 是 | int | 专题分类 ID |
page | 否 | int | 页码 |
per_page | 否 | int | 每页展示多少数据 默认 30 |
{
"result": true,
"data": {
"per_page": "2",
"total": 1137,
"data": [
{
"id": 16,
"title": "飞屋",
"cover_image": "https://ali.image.hellorf.com/crm/3020161117214611049.jpg",
"video_cnt": 64
},
{
"id": 23,
"title": "圣诞专辑",
"cover_image": "https://ali.image.hellorf.com/crm/3020161117215061466.jpg",
"video_cnt": 84
}
]
}
}
接口地址 video/topic/{$id}
请求方法 GET
参数列表
参数名 | 必填 | 类型 | 说明 |
---|
{
"result": true,
"data": {
"id": 1,
"title": "Night office",
"cover_video": "https://ali.image.hellorf.com/images/f46c77c9fb0db855d5a8395f4489a5e6.mp4",
"list": [
{
"id": 131096951,
"aspect": "1.5026",
"description": "LONDON - JAN 31: people work in an office building in London on January 31, 2013. Full-time employees in the UK work longer hours than the EU average, according to the Office for National Statistics.",
"preview_mp4_url": "http://thumb109.test-ss.cn/thumb_large/595720/131096951/stock-photo-london-jan-people-work-in-an-office-building-in-london-on-january-full-time-131096951.mp4",
"preview_jpg_url": "http://thumb109.test-ss.cn/display_pic_with_logo/595720/131096951/stock-photo-london-jan-people-work-in-an-office-building-in-london-on-january-full-time-131096951.jpg",
"duration": 100,
},
{
"id": 110352362,
"aspect": "1.5",
"description": "office buildings",
"preview_mp4_url": "http://thumb106.test-ss.cn/thumb_large/496018/110352362/stock-photo-office-buildings-110352362.mp4",
"preview_jpg_url": "http://thumb106.test-ss.cn/display_pic_with_logo/496018/110352362/stock-photo-office-buildings-110352362.jpg",
"duration": 100,
}
]
}
}
接口地址 video/{$id}/similar
请求方法 GET
参数列表
参数名 | 必填 | 类型 | 说明 |
---|
返回结果
{
"result": true,
"data": [
{
"id": "6538724",
"aspect": 1.778,
"description": "Colorful Ink Splash in Underwater",
"duration": 31,
"preview_mp4_url": "http://47.88.150.139/ak4/shutterstock/videos/6538724/preview/stock-footage-colorful-ink-splash-in-underwater.mp4",
"preview_jpg_url": "http://ak4.picdn.net/shutterstock/videos/6538724/thumb/11.jpg",
"thumb_mp4_url": "http://47.88.150.139/ak4/shutterstock/videos/6538724/thumb/stock-footage-colorful-ink-splash-in-underwater.mp4"
},
]
}
接口地址 video/categories
请求方法 GET
参数列表
参数名 | 必填 | 类型 | 说明 |
---|
返回结果
{
"result": true,
"data": [
{
"id": 1,
"name": "动物/野生生物",
},
{
"id": 2,
"name": "建筑物/地标",
},
]
}
接口地址 video/my-purchases
请求方法 GET
参数列表
参数名 | 必填 | 类型 | 说明 |
---|---|---|---|
begin_at | 否 | TIMESTAMP | 开始时间 例如:2017-01-01 23:23:23 |
end_at | 否 | TIMESTAMP | 结束时间 例如:2017-01-01 23:23:23 |
is_download | 否 | int | 是否下载 默认值全部 1 是 2 否 |
video_id | 否 | string | 视频 ID |
per_page | 否 | int | 每页数量 默认值 10 |
page | 否 | int | 哪一页 默认值第一页 |
返回结果
{
"result": true,
"data": {
"per_page": "10",
"total": 1,
"list": [
{
"id": 178,
"plus_user": {
"id": 14949528,
"name": "didi"
},
"real_plus_user": {
"id": 14949528,
"name": "didi"
},
"third_user_id": "",
"plus_permission": {
"id": 33,
"name": "HD"
},
"able_id": 8126014,
"able_type": "video",
"asset_type": "hd",
"warrant_name": "广州汽车集团股份有限公司",
"download_at": "2016-08-29 17:09:02",
"created_at": "2016-08-29 16:41:47"
}
]
}
}
接口地址 video/download-warrant
请求方法 GET
参数列表
参数名 | 必填 | 类型 | 说明 |
---|---|---|---|
purchase_id | 是 | int | 购买 ID |
返回结果
FILE
接口地址 video/purchase-download
请求方法 GET
参数列表
参数名 | 必填 | 类型 | 说明 |
---|---|---|---|
purchase_id | 是 | int | 购买 ID |
返回结果
{
"result": true,
"data": {
"url": "http://www.hellorf.com/shutterstock/gatekeeper/W3siZSI6MTUwNDYxMDkwOCwiZGMiOiJpZGxfMTI3MTQ3NTA1IiwiayI6InBob3RvLzEyNzE0NzUwNS92ZWN0b3IuZXBzIiwibSI6IjEiLCJkIjoic2h1dHRlcnN0b2NrLW1lZGlhIn0sIkdoanAwTlFHdC8yY3F2Z1hua1Zxay9qTUZDTSJd/shutterstock_127147505.avi"
}
}
接口地址 video/purchase-detail
请求方法 GET
参数列表
参数名 | 必填 | 类型 | 说明 |
---|---|---|---|
purchase_id | 是 | int | 购买 ID |
返回结果
{
"result" : true,
"data" : {
"image" : {
"id" : "409749292", // 视频ID
"preview_mp4_url" : "https://hellorfimg.zcool.cn/preview/409749292.jpg", // 预览视频
"preview_jpg_url" : "https://image.shutterstock.com/z/stock-photo-409749292.jpg", // 预览图
"aspect" : 1.50, // 宽高比
"title" : "Two businesswoman having an informal meeting", // 标题
"keywords" : [ // 关键字
"explain",
"communicate",
"conference",
"occupation",
],
"has_model_release" : true, // 肖像权
"has_property_release" : true, // 物权
"category_ids" : [ // 视频分类ID
"13",
"4"
],
"created_at" : "2019-05-09 23:57:05" // 视频创建时间
},
"purchase" : {
"id" : 1, // 购买记录ID
"permission_id" : 27, // 权限ID
"permission_name" : "xxxxx", // 权限名称
"plus_user_id" : 14627888, // 主账号ID
"real_plus_user_id" : 14627888, // 实际购买账号ID
"price" : "812.50", // 价格
"asset_type" : "huge_jpg", // 购买尺寸
"warrant_name" : "测试", // 授权主体名称
"fileSize" : "11.5MB", // 所够买尺寸对应文件大小
"created_at" : "2016-06-24 09:24:33" // 购买时间
}
}
}