基础参数
参数 | 必选 | 类型 | 名称 | 说明 |
---|---|---|---|---|
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分钟。
接口地址 image/categories
请求方法 GET
参数列表
返回结果
{
"result": true,
"data": [
{
"id": 0,
"name": "交通运输"
},
{
"id": 16,
"name": "科技"
}
]
}
接口地址 image/search
请求方法 GET
参数列表
参数名 | 必填 | 类型 | 说明 |
---|---|---|---|
keyword | 是 | string | 查询的关键字。支持多关键词搜索,AND、OR、NOT 条件。多关键词用空格分割,多条件用括号分割。 |
page | 是 | int | 哪一页 |
per_page | 否 | int | 每页数量 最大值 100 |
category | 否 | string | 分类 ID |
image_type | 否 | string | 图片类型:全部为空,照片 photo, 插画 illustration, 矢量图 vector |
color | 否 | string | 颜色:#0ecb9b,#0bbbf5,#1f55f8,#0000ff,#7f00ff,#bf00ff,#ea06b1,#e72525,#f48700,#eca71d,#f1f129,#a9e418,#06d506,#000000 |
height | 否 | int | 高 |
width | 否 | int | 宽 |
orientation | 否 | string | 图片方向: horizontal, vertical |
people_age | 否 | string | 图片人物年龄段 infants, children, teenagers, 20s, 30s, 40s, 50s, 60s, older |
people_gender | 否 | string | 性别 male, female, both |
people_number | 否 | string | 人数 |
people_model_released | 否 | boolean | 是否含有肖像权 |
origin | 否 | boolean | 是否只看国内 |
people_ethnicity | 否 | string | 种族:黑人 black,白人 caucasian,拉美西班牙裔 hispanic,中东人 middle_eastern,东南亚人 southeast_asian,中国人 chinese |
contributor | 否 | string | 作者名称 |
width_from | 否 | int | 起始宽 |
width_to | 否 | int | 终止宽 |
height_from | 否 | int | 起始高 |
height_to | 否 | int | 终止高 |
sort | 否 | string | 排序,最新:newest,热门:popular(默认),匹配度:relevance |
返回结果
{
"result": true,
"data": {
"per_page": 100, //每页数量
"total": 10763, //总数量
"list": [
{
"id": "363488282",
"aspect": 1.4984, //宽高比
"title": "云南洱海",
"preview_url": "https://image.shutterstock.com/display_pic_with_logo/131785/363488282/stock-photo-amazing-view-of-the-jade-dragon-snow-mountain-and-the-black-dragon-pool-lijiang-yunnan-province-363488282.jpg",
"preview_large_url": "https://image.shutterstock.com/z/stock-photo-363488282.jpg",
"preview260_url": "https://image.shutterstock.com/z/stock-photo-363488282.jpg"
},
{
"id": 2234602517,
"aspect": "1.50",
"title": "云南洱海",
"preview_url": "http://ali.image.hellorf.com/hellorf/fd/7d/ae6ed152b5c0785e037fed7d7328/thumb_b_2234602517.jpg",
"preview_large_url": "http://hellorfimg.zcool.cn/provider_image/large/2234602517.jpg",
"preview260_url": "https://image.shutterstock.com/z/stock-photo-363488282.jpg"
}
]
}
接口地址 image/detail
请求方法 GET
参数列表
参数名 | 必填 | 类型 | 说明 |
---|---|---|---|
image_id | 是 | string | 图片 ID |
返回结果
{
"result": true,
"data": {
"image": {
"_id": "1111435439",
"aspect": 1.498,
"image_type": "photo",
"category_ids": [
"12"
],
"title": "close up of cosmos flowers in the garden",
"id": "1111435439",
"keywords": [],
"extension": "jpg",
"preview_url": "https://image.shutterstock.com/display_pic_with_logo/4244749/1111435439/stock-photo-close-up-of-cosmos-flowers-in-the-garden-1111435439.jpg",
"preview260_url": "https://image.shutterstock.com/image-photo/-260nw-1111435439.jpg",
"is_editorial": false
},
"author": "Jantana Phattha",
"permissions": [
{
"id": 13470,
"name": "图片样片",
"price": "0.00",
"text": "1000 x 668 px (72dpi)",
"size": "556.7KB",
"size_level": 4,
"width": 1000,
"height": 668,
"dpi": 72
},
{
"id": 13493,
"name": "图片样片",
"price": "0.00",
"text": "1000 x 668 px (72dpi)",
"size": "556.7KB",
"size_level": 4,
"width": 1000,
"height": 668,
"dpi": 72
}
]
}
}
接口地址 image/purchase
请求方法 POST
参数列表
参数名 | 必填 | 类型 | 说明 |
---|---|---|---|
image_id | 是 | string | 图片 ID |
permission_id | 是 | int | 权限 ID |
warrant_name | 是 | string | 授权用户名称 |
third_user_id | 否 | string | 第三方用户 ID 平台方必传 |
返回结果
{
"result": true,
"data": {
"id": 52,
"url": "http://download.hellorf.com/hellorf/6b/0f/be36d08b8498c9a619608c089115/hellorf_2234567973.jpg" //下载地址
}
}
接口地址 image/topic/categories
请求方法 GET
参数列表
参数名 | 必填 | 类型 | 说明 |
---|
返回结果
{
"result": true,
"data": [
{
"id": 1022,
"name": "生活",
"description": ""
},
{
"id": 1023,
"name": "设计素材",
"description": ""
},
{
"id": 1028,
"name": "人物",
"description": ""
},
]
}
接口地址 image/topic/hots
请求方法 GET
参数列表
参数名 | 必填 | 类型 | 说明 |
---|---|---|---|
category_id | 否 | int | 专题分类 ID |
返回结果
{
"result": true,
"data": [
{
"id": 1,
"title": "Night office",
"cover_image":"", // 长封面,规格:2000 × 900
"short_cover":"", // 短封面,规格:534 × 400
"image_cnt": 10, // 图片数量
},
{
"id": 2,
"title": "双重曝光",
"cover_image":"",
"image_cnt": 10,
},
{
"id": 3,
"title": "首页大图",
"cover_image":"",
"image_cnt": 10,
}
]
}
接口地址 image/topic/{$id}
请求方法 GET
参数列表
参数名 | 必填 | 类型 | 说明 |
---|---|---|---|
page | 是 | int | 哪一页 |
per_page | 否 | int | 每页数量 默认值 200 |
返回结果
{
"result": true,
"data": {
"id": 1,
"title": "Night office",
"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_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"
},
{
"id": 110352362,
"aspect": "1.5",
"description": "office buildings",
"preview_url": "http://thumb106.test-ss.cn/display_pic_with_logo/496018/110352362/stock-photo-office-buildings-110352362.jpg"
}
]
}
}
接口地址 image/{$id}/similar
请求方法 GET
参数列表
参数名 | 必填 | 类型 | 说明 |
---|
返回结果
{
"result": true,
"data": [
{
"id": "314834948",
"aspect": 1.5,
"description": "Head and shoulders portrait of a young businesswoman smiling",
"preview_url": "http://thumb109.test-ss.cn/display_pic_with_logo/187633/314834948/stock-photo-head-and-shoulders-portrait-of-a-young-businesswoman-smiling-314834948.jpg",
"preview260_url": "https://image.shutterstock.com/image-photo/-260nw-1111436675.jpg"
},
{
"id": "160580261",
"aspect": 1.5,
"description": "Beautiful businesswoman outdoor in the city",
"preview_url": "http://thumb103.test-ss.cn/display_pic_with_logo/210376/160580261/stock-photo-beautiful-businesswoman-outdoor-in-the-city-160580261.jpg",
"preview260_url": "https://image.shutterstock.com/image-photo/-260nw-1111436675.jpg"
}
]
}
接口地址 image/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 否 |
image_id | 否 | string | 图片 ID |
per_page | 否 | int | 每页数量 默认值 10 |
page | 否 | int | 哪一页 默认值第一页 |
返回结果
{
"result": true,
"data": {
"per_page": 10, //每页数量
"total": 1, //总数量
"list": [
{
"id": 35, //购买ID
"plus_user": { //购买用户
"id": 14563341,
"name": "xxx"
},
"real_plus_user": { //真实购买用户
"id": 14563341,
"name": "xxxx"
},
"third_user_id": "", //第三方用户ID
"plus_permission": { //购买权限
"id": 42,
"name": "图片样片"
},
"able_id": 2234622970, //购买资源ID
"able_type": "image", //购买资源名称
"asset_type": "medium_jpg", //资源大小
"price": "100", //价格
"warrant_name": "", //授权名称
"download_at": "2017-02-25 00:32:18", //下载时间
"created_at": "2017-02-25 00:32:18" // 购买时间
}
]
}
}
接口地址 image/download-warrant
请求方法 GET
参数列表
参数名 | 必填 | 类型 | 说明 |
---|---|---|---|
purchase_id | 是 | int | 购买 ID |
返回结果
FILE
接口地址 image/purchase-download
请求方法 GET
参数列表
参数名 | 必填 | 类型 | 说明 |
---|---|---|---|
purchase_id | 是 | int | 购买 ID |
返回结果
{
"result": true,
"data": {
"url": "http://download.hellorf.com/hellorf/71/3f/3d23d8a247ff9adfea92c99cb9e4/hellorf_2234622970.jpg" //下载地址
}
}
接口地址 image/purchase-detail
请求方法 GET
参数列表
参数名 | 必填 | 类型 | 说明 |
---|---|---|---|
purchase_id | 是 | int | 购买 ID |
返回结果
{
"result" : true,
"data" : {
"image" : {
"id" : "409749292", // 图片ID
"preview_url" : "https://hellorfimg.zcool.cn/preview/409749292.jpg", // 450px 预览图
"preview260_url" : "https://hellorfimg.zcool.cn/preview260/409749292.jpg", // 260px 预览图
"preview_large_url" : "https://image.shutterstock.com/z/stock-photo-409749292.jpg", // 1000px+ 预览图
"aspect" : 1.50, // 宽高比
"title" : "Two businesswoman having an informal meeting", // 标题
"keywords" : [ // 关键字
"explain",
"communicate",
"conference",
"occupation",
],
"format" : "JPG", // 图片格式 [EPS, JPG]
"image_type" : "photo", // 图片类型 [photo, illustration, vector]
"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" // 购买时间
}
}
}
接口地址 image/simi-search
请求方法 POST
参数列表
参数名 | 必填 | 类型 | 说明 |
---|---|---|---|
url | 否 | string | 图片地址 url 和 file 必须二选一并且图片大小不能大于 4M |
file | 否 | file | 图片源 base64 格式 此参数不计入签名 |
per_page | 否 | int | 数量,最大值 100 |
返回结果
{
"result": true,
"data": [
{
"id": "123692176",
"aspect": 1.4286,
"description": "Futuristic background - circle",
"preview_url": "http://thumb102.test-ss.cn/display_pic_with_logo/1088888/123692176/stock-photo-futuristic-background-circle-123692176.jpg",
"preview260_url": "https://image.shutterstock.com/image-photo/-260nw-734067445.jpg"
},
{
"id": "200879663",
"aspect": 1,
"description": "Vector Glossy Sphere. Abstract Background ",
"preview_url": "http://thumb106.test-ss.cn/display_pic_with_logo/922130/200879663/stock-vector-vector-glossy-sphere-abstract-background-200879663.jpg",
"preview260_url": "https://image.shutterstock.com/image-photo/-260nw-200879663.jpg"
}
]
}