作品截图
描述
本接口用于对已有的作品进行截图，可以选择作品的图片格式（jpg/png）
此功能有两个接口：
- 生成作品的截图任务，并返回截图任务id
- 根据截图任务id，查询作品的截图结果
接口鉴权
接口地址一
【POST】https://open-api.gaoding.com/api/call/shot
请求头（request header）
字段 | 类型 | 是否必填 | 字段描述 |
app_id | string | 是 | 应用ID，获取方式：应用列表 -> 应用详情 -> APP ID |
请求体（request body）
字段 | 类型 | 是否必填 | 字段描述 |
target_id | long | 是 | 作品Id |
shot_type | string | 是 | 截图类型（JPG/PNG） |
background_alpha | int | 否 | 是否设置图片为透明（PNG格式才需要设置） 0：透明1：不透明（默认值） |
请求体示例：
{
"target_id": 23654875496597506,
"shot_type": "png",
"background_alpha": 0
}响应体（response body）
字段 | 类型 | 是否必存在 | 字段描述 |
id | long | 是 | 返回截图的任务Id |
响应示例1（模拟正常请求）
http_status：200
response body：
{
"id": 1816286268
}响应示例2（模拟参数非法请求）
http_status：404
response body：
{
"code": "404",
"message": "资源不存在"
}错误码
HTTP状态码 | 含义 |
404 | 资源不存在 |
403 | 当前内容id不属于该租户 |
400 | target_id不能为空 |
400 | shot_type不能为空 |
400 | shot_type入参错误 |
500 | 服务器错误 |
接口地址二
【GET】https://open-api.gaoding.com/api/call/shots/{taskId}
请求URL示例：
https://open-api.gaoding.com/api/call/shots/1816285280
响应体（response body）
字段 | 类型 | 是否必存在 | 字段描述 | |
id | long | 是 | 任务Id | |
status | int | 是 | 任务状态 0:处理中 1:成功 2:失败 | |
result | object | 是 | 任务结果 | |
url | string | 否 | 图片url（任务成功时才有值） 接口有效期为1天，过期后该接口无数据返回 | |
响应示例1（模拟正常请求）
http_status：200
response body：
{
"id": 1816285280,
"status": 1,
"result": {
"url": "https://gdesign-dam.dancf.com/23654875496597506/preview/shots/20230404-105640-3qRHQ.png"
}
}响应示例2（截图失败或已过期的请求）
http_status：200
response body：
{
"id": 1816220553,
"status": 2,
"result": {
"url": null
}
}备注
- 作品截图存在失败的可能性（status=2），当截图失败后，用户需要重新发起截图请求
- 作品截图为异步执行，不保证查询时能立刻返回执行成功的状态。若查询的状态为截图中（status=0），则需要用户再次发起查询请求
错误码
HTTP状态码 | 含义 |
12031027 | 系统异常 |
500 | 服务器错误 |