关于 素材 ​
访问范围
需要多个访问范围—请参阅每个端点以了解访问范围要求。
需要访问受保护的客户数据。
素材是 Genstore 的核心业务模块,管理店铺内的图片、视频等类型的素材文件。
核心功能
素材 对象 ​
素材代表商家可以上传到其商店的数字资产,用于各种目的,包括产品图片、营销材料、文档和品牌资产
属性 ​
materialobjectrequired
- 收起属性
idstringrequired
素材id
durationstringrequired
持续时长【用于音,视频】
optimizeUrlstringrequired
优化后的资源Url
materialFileTypestringrequired
materialTypes下的子级分类;
*素材类型 1:图片; 文件类型1:bmp,文件类型2:png,文件类型3:jpeg,文件类型4:jpg,文件类型5:gif,文件类型24:svg,文件类型25:webp,文件类型26:heic,
*素材类型 2:音频; 文件类型6:mp3,文件类型7:wma, 文件类型8:wav,文件类型9:amr,文件类型28:aac,
*素材类型 3:视频; 文件类型10:mp4,文件类型11:flv,文件类型12:f4v,文件类型13:webm,文件类型14:avi,文件类型27:mov,
*素材类型 4:文件; 文件类型15:doc,文件类型16:docx,文件类型18:xls,文件类型19:xlsx,文件类型20:ppt,文件类型21:pptx,文件类型22:pdf,文件类型30:css,文件类型31:rar,文件类型32:rtf,文件类型33:txt,文件类型34:zip,文件类型35:dotx,文件类型36:json,文件类型37:potx,文件类型38:ppsx,文件类型39:xmind,
*素材类型 1:图片; 文件类型1:bmp,文件类型2:png,文件类型3:jpeg,文件类型4:jpg,文件类型5:gif,文件类型24:svg,文件类型25:webp,文件类型26:heic,
*素材类型 2:音频; 文件类型6:mp3,文件类型7:wma, 文件类型8:wav,文件类型9:amr,文件类型28:aac,
*素材类型 3:视频; 文件类型10:mp4,文件类型11:flv,文件类型12:f4v,文件类型13:webm,文件类型14:avi,文件类型27:mov,
*素材类型 4:文件; 文件类型15:doc,文件类型16:docx,文件类型18:xls,文件类型19:xlsx,文件类型20:ppt,文件类型21:pptx,文件类型22:pdf,文件类型30:css,文件类型31:rar,文件类型32:rtf,文件类型33:txt,文件类型34:zip,文件类型35:dotx,文件类型36:json,文件类型37:potx,文件类型38:ppsx,文件类型39:xmind,
sizestringrequired
素材大小;单位B
coverImageUrlstringrequired
封面url
materialTypestringrequired
素材类型, 1-图片,2-音频,3-视频,4-文件
titlestringrequired
素材标题
materialDetailExtsarrayrequired
素材扩展属性; 例如: 宽,高 [{"key":"width","value":"675"},{"key":"height","value":"483"}]
+ 展开属性
urlstringrequired
素材url
introductionstringrequired
素材描述
bash
{
"material": {
"duration": "122",
"optimizeUrl": "https://image-c-pioneer.weimobqa.com/qa-2TL/3d19b66355d04653a722cb3e116620f9.webp",
"materialFileType": "1",
"size": "1111",
"coverImageUrl": "https://image-c-pioneer.weimobqa.com/qa-2TL/3d19b66355d04653a722cb3e116620f9.jpg",
"materialType": "1",
"id": "123",
"title": "霸王十代",
"materialDetailExts": [
{
"value": "",
"key": ""
}
],
"url": "https://image-c-pioneer.weimobqa.com/qa-2TL/4022047364584/57051e41027b414b91a4dadfd3268d68.png",
"introduction": "霸王十代"
}
}
POST
新增素材 ​
使用外部URl创建Genstore店铺素材。
访问范围
需要以下任意访问权限: write_materials
接口
POST
/api/202412/material
请求参数
materialobjectrequired
- 收起属性
urlstringrequired
素材链接
titlestringrequired
素材标题
sizenumberrequired
素材大小;单位B
durationnumber
持续时长【用于音,视频】
materialTypenumberrequired
素材类型(1--图片,2--音频,3--视频,4--文件)
introductionstring
当前素材的描述,用于对文件进行说明。
materialFileTypenumberrequired
materialTypes下的子级分类;
*素材类型 1:图片; 文件类型1:bmp,文件类型2:png,文件类型3:jpeg,文件类型4:jpg,文件类型5:gif,文件类型24:svg,文件类型25:webp,文件类型26:heic,
*素材类型 2:音频; 文件类型6:mp3,文件类型7:wma, 文件类型8:wav,文件类型9:amr,文件类型28:aac,
*素材类型 3:视频; 文件类型10:mp4,文件类型11:flv,文件类型12:f4v,文件类型13:webm,文件类型14:avi,文件类型27:mov,
*素材类型 4:文件; 文件类型15:doc,文件类型16:docx,文件类型18:xls,文件类型19:xlsx,文件类型20:ppt,文件类型21:pptx,文件类型22:pdf,文件类型30:css,文件类型31:rar,文件类型32:rtf,文件类型33:txt,文件类型34:zip,文件类型35:dotx,文件类型36:json,文件类型37:potx,文件类型38:ppsx,文件类型39:xmind,
*素材类型 1:图片; 文件类型1:bmp,文件类型2:png,文件类型3:jpeg,文件类型4:jpg,文件类型5:gif,文件类型24:svg,文件类型25:webp,文件类型26:heic,
*素材类型 2:音频; 文件类型6:mp3,文件类型7:wma, 文件类型8:wav,文件类型9:amr,文件类型28:aac,
*素材类型 3:视频; 文件类型10:mp4,文件类型11:flv,文件类型12:f4v,文件类型13:webm,文件类型14:avi,文件类型27:mov,
*素材类型 4:文件; 文件类型15:doc,文件类型16:docx,文件类型18:xls,文件类型19:xlsx,文件类型20:ppt,文件类型21:pptx,文件类型22:pdf,文件类型30:css,文件类型31:rar,文件类型32:rtf,文件类型33:txt,文件类型34:zip,文件类型35:dotx,文件类型36:json,文件类型37:potx,文件类型38:ppsx,文件类型39:xmind,
响应数据
materialobjectrequired
- 收起属性
idnumberrequired
素材id
materialTypenumberrequired
素材类型,
*1图片,
*2音频,
*3视频,
*4文件
*1图片,
*2音频,
*3视频,
*4文件
titlestringrequired
素材标题
urlstringrequired
素材url
sizenumberrequired
素材大小;单位B
introductionstringrequired
素材描述
materialFileTypenumberrequired
materialTypes下的子级分类;
*素材类型 1:图片; 文件类型1:bmp,文件类型2:png,文件类型3:jpeg,文件类型4:jpg,文件类型5:gif,文件类型24:svg,文件类型25:webp,文件类型26:heic,
*素材类型 2:音频; 文件类型6:mp3,文件类型7:wma, 文件类型8:wav,文件类型9:amr,文件类型28:aac,
*素材类型 3:视频; 文件类型10:mp4,文件类型11:flv,文件类型12:f4v,文件类型13:webm,文件类型14:avi,文件类型27:mov,
*素材类型 4:文件; 文件类型15:doc,文件类型16:docx,文件类型18:xls,文件类型19:xlsx,文件类型20:ppt,文件类型21:pptx,文件类型22:pdf,文件类型30:css,文件类型31:rar,文件类型32:rtf,文件类型33:txt,文件类型34:zip,文件类型35:dotx,文件类型36:json,文件类型37:potx,文件类型38:ppsx,文件类型39:xmind,
*素材类型 1:图片; 文件类型1:bmp,文件类型2:png,文件类型3:jpeg,文件类型4:jpg,文件类型5:gif,文件类型24:svg,文件类型25:webp,文件类型26:heic,
*素材类型 2:音频; 文件类型6:mp3,文件类型7:wma, 文件类型8:wav,文件类型9:amr,文件类型28:aac,
*素材类型 3:视频; 文件类型10:mp4,文件类型11:flv,文件类型12:f4v,文件类型13:webm,文件类型14:avi,文件类型27:mov,
*素材类型 4:文件; 文件类型15:doc,文件类型16:docx,文件类型18:xls,文件类型19:xlsx,文件类型20:ppt,文件类型21:pptx,文件类型22:pdf,文件类型30:css,文件类型31:rar,文件类型32:rtf,文件类型33:txt,文件类型34:zip,文件类型35:dotx,文件类型36:json,文件类型37:potx,文件类型38:ppsx,文件类型39:xmind,
coverImageUrlstringrequired
封面url
materialDetailExtsarrayrequired
素材扩展属性; 例如: 宽,高 [{"key":"width","value":"675"},{"key":"height","value":"483"}]
+ 展开属性
durationnumberrequired
持续时长【用于音,视频】
optimizeUrlstringrequired
优化后的资源Url
bash
curl -X POST \
https://{shop}.genmystore.com/api/202412/material" \
-H "X-Genstore-Access-Token: {access_token}" \
-H "Content-Type: application/json" \
-d '{
"material":{
"duration":"108",
"materialFileType":"1",
"size":"10245",
"materialType":"1",
"title":"Front view image of Apple Watch",
"url":"https://image-c.genstoredev.com/qa-34K/4022109170826/a34555550e704aa8994cc44c9c375b58.jpg",
"introduction":"Front view image of Apple Watch"
}
}'
json
HTTP/1.1 200 OK
{
"material": {
"duration": "537",
"optimizeUrl": "https://image-c-pioneer.weimobqa.com/qa-2TL/3d19b66355d04653a722cb3e116620f9.webp",
"materialFileType": "1",
"size": "4236498",
"coverImageUrl": "https://image-c-pioneer.weimobqa.com/qa-2TL/3d19b66355d04653a722cb3e116620f9.jpg",
"materialType": "1",
"id": "11592",
"title": "霸王十代",
"materialDetailExts": [
{
"value": "128",
"key": "with"
}
],
"url": "https://image-c-pioneer.weimobqa.com/qa-2TL/4022047364584/57051e41027b414b91a4dadfd3268d68.png",
"introduction": "霸王十代"
}
}
GET
素材列表 ​
弹窗素材列表
访问范围
需要以下任意访问权限: read_materials
接口
GET
/api/202412/materials
请求参数
materialTypesarrayrequired
素材类型,
*1图片,
*2音频,
*3视频,
*4文件
*1图片,
*2音频,
*3视频,
*4文件
materialFileTypearray
materialTypes下的子级分类;
*素材类型 1:图片; 文件类型1:bmp,文件类型2:png,文件类型3:jpeg,文件类型4:jpg,文件类型5:gif,文件类型24:svg,文件类型25:webp,文件类型26:heic,
*素材类型 2:音频; 文件类型6:mp3,文件类型7:wma, 文件类型8:wav,文件类型9:amr,文件类型28:aac,
*素材类型 3:视频; 文件类型10:mp4,文件类型11:flv,文件类型12:f4v,文件类型13:webm,文件类型14:avi,文件类型27:mov,
*素材类型 4:文件; 文件类型15:doc,文件类型16:docx,文件类型18:xls,文件类型19:xlsx,文件类型20:ppt,文件类型21:pptx,文件类型22:pdf,文件类型30:css,文件类型31:rar,文件类型32:rtf,文件类型33:txt,文件类型34:zip,文件类型35:dotx,文件类型36:json,文件类型37:potx,文件类型38:ppsx,文件类型39:xmind,
*素材类型 1:图片; 文件类型1:bmp,文件类型2:png,文件类型3:jpeg,文件类型4:jpg,文件类型5:gif,文件类型24:svg,文件类型25:webp,文件类型26:heic,
*素材类型 2:音频; 文件类型6:mp3,文件类型7:wma, 文件类型8:wav,文件类型9:amr,文件类型28:aac,
*素材类型 3:视频; 文件类型10:mp4,文件类型11:flv,文件类型12:f4v,文件类型13:webm,文件类型14:avi,文件类型27:mov,
*素材类型 4:文件; 文件类型15:doc,文件类型16:docx,文件类型18:xls,文件类型19:xlsx,文件类型20:ppt,文件类型21:pptx,文件类型22:pdf,文件类型30:css,文件类型31:rar,文件类型32:rtf,文件类型33:txt,文件类型34:zip,文件类型35:dotx,文件类型36:json,文件类型37:potx,文件类型38:ppsx,文件类型39:xmind,
keywordstring
搜索关键词
sizenumber
素材大小
sizeRangearray
素材大小区间
durationRangearray
持续时长区间【用于音,视频】
durationnumber
持续时长【用于音,视频】
inListarray
素材id列表
pageTokennumberrequired
当前页
limitnumberrequired
每页大小
sortListstring
排序对象; 支持多字段联合排序. json字符串对象urlEncode后的字符串; jscode形如: encodeURIComponent("[{\"field\":\"title\",\"order\":1}]")
响应数据
materialsarrayrequired
分页数据
- 收起属性
idnumberrequired
素材id
materialTypenumberrequired
素材类型,
*1图片,
*2音频,
*3视频,
*4文件
*1图片,
*2音频,
*3视频,
*4文件
titlestring
素材标题
urlstringrequired
素材url
sizenumberrequired
素材大小;单位B
durationnumber
持续时长【用于音,视频】
introductionstring
素材描述
materialFileTypenumberrequired
materialTypes下的子级分类;
*素材类型 1:图片; 文件类型1:bmp,文件类型2:png,文件类型3:jpeg,文件类型4:jpg,文件类型5:gif,文件类型24:svg,文件类型25:webp,文件类型26:heic,
*素材类型 2:音频; 文件类型6:mp3,文件类型7:wma, 文件类型8:wav,文件类型9:amr,文件类型28:aac,
*素材类型 3:视频; 文件类型10:mp4,文件类型11:flv,文件类型12:f4v,文件类型13:webm,文件类型14:avi,文件类型27:mov,
*素材类型 4:文件; 文件类型15:doc,文件类型16:docx,文件类型18:xls,文件类型19:xlsx,文件类型20:ppt,文件类型21:pptx,文件类型22:pdf,文件类型30:css,文件类型31:rar,文件类型32:rtf,文件类型33:txt,文件类型34:zip,文件类型35:dotx,文件类型36:json,文件类型37:potx,文件类型38:ppsx,文件类型39:xmind,
*素材类型 1:图片; 文件类型1:bmp,文件类型2:png,文件类型3:jpeg,文件类型4:jpg,文件类型5:gif,文件类型24:svg,文件类型25:webp,文件类型26:heic,
*素材类型 2:音频; 文件类型6:mp3,文件类型7:wma, 文件类型8:wav,文件类型9:amr,文件类型28:aac,
*素材类型 3:视频; 文件类型10:mp4,文件类型11:flv,文件类型12:f4v,文件类型13:webm,文件类型14:avi,文件类型27:mov,
*素材类型 4:文件; 文件类型15:doc,文件类型16:docx,文件类型18:xls,文件类型19:xlsx,文件类型20:ppt,文件类型21:pptx,文件类型22:pdf,文件类型30:css,文件类型31:rar,文件类型32:rtf,文件类型33:txt,文件类型34:zip,文件类型35:dotx,文件类型36:json,文件类型37:potx,文件类型38:ppsx,文件类型39:xmind,
coverImageUrlstring
封面url
materialDetailExtsarrayrequired
素材扩展属性; 例如: 宽,高 [{"key":"width","value":"675"},{"key":"height","value":"483"}]
+ 展开属性
optimizeUrlstringrequired
优化后的资源Url
bash
curl -X GET \
https://{shop}.genmystore.com/api/202412/materials" \
-H "X-Genstore-Access-Token: {access_token}" \
json
HTTP/1.1 200 OK
{
"materials": [
{
"duration": "537",
"optimizeUrl": "https://image-c-pioneer.weimobqa.com/qa-2TL/3d19b66355d04653a722cb3e116620f9.webp",
"materialFileType": "1",
"size": "4236498",
"coverImageUrl": "https://image-c-pioneer.weimobqa.com/qa-2TL/3d19b66355d04653a722cb3e116620f9.jpg",
"materialType": "1",
"id": "11592",
"title": "霸王十代",
"materialDetailExts": [
{
"value": "4236498",
"key": "size"
}
],
"url": "https://image-c-pioneer.weimobqa.com/qa-2TL/4022047364584/57051e41027b414b91a4dadfd3268d68.png",
"introduction": "霸王十代"
}
]
}
关于 素材
访问范围
需要多个访问范围—请参阅每个端点以了解访问范围要求。
需要访问受保护的客户数据。
素材是 Genstore 的核心业务模块,管理店铺内的图片、视频等类型的素材文件。
核心功能
素材 对象
素材代表商家可以上传到其商店的数字资产,用于各种目的,包括产品图片、营销材料、文档和品牌资产
属性
POST
新增素材
使用外部URl创建Genstore店铺素材。
访问范围
需要以下任意访问权限: write_materials
接口
POST
/api/202412/material
GET
素材列表
弹窗素材列表
访问范围
需要以下任意访问权限: read_materials
接口
GET
/api/202412/materials