跳到主要内容

创建自定义图片背景

1.接口说明​

用户除了可以使用系统预置的图片背景外，也可以上传图片，创建自定义的图片背景。

请求该接口，提供自定义图片背景素材信息，创建自定义图片背景，获取图片背景上传地址。

2.请求地址​

https://digitbot.bokecc.com/api/background/image/custom/create

3.请求方式​

POST application/json

4.请求参数​

(1).公共参数，参考服务说明。​

(2).接口参数​

①.Query参数：通过URL参数传递。​

参数名类型必需说明
versionString是接口版本号，当前支持版本：1.0.0。
projectIdString是项目ID。

②.Body参数：通过请求Body传递，JSON格式。​

参数名类型必需说明
filenameString是图片文件名，最多100个字符，要求文件名带扩展名(后缀名)。
sizeLong是图片大小，单位：B(字节)。最大支持5MB。
md5String是图片文件md5。

5.请求示例​

POST https://digitbot.bokecc.com/api/background/image/custom/create?projectId=xxx&accountId=xxx&version=1.0.0&hash=xxx&time=xxx HTTP/1.1
{
    "filename": "春天.png",
	"size": 1234567,
	"md5": "xxxxxxxxxxxxxxxx"
}

6.响应示例​

{
  "id": "xxx",
  "uploadUrl": "https://xxxx.xxxx/xxxx"
}

7.响应说明​

字段名类型说明
idString背景ID。
uploadUrlString背景图片上传地址。
  • uploadUrl：使用该图片背景文件上传地址，以PUT方式，将图片文件数据上传到该地址即可。
    • 上传时需要设置Content-Type请求头。
    • 该地址上传失败时，可以重新从头开始上传。
    • 上传成功后，该地址不再接收数据，不可重新上传。
    • 地址有效时间2小时。
    • 可参考上传示例。