API 文档

SDK 文档

诚邀爱技术、爱分享的你,成为文档内容共建者> HOT

功能描述

解析保存 PSD 文件模板。

请求

请求实例

POST /posterproduction/template HTTP/1.1
Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Content-Length: <length>
Content-Type: application/xml

<body>

说明:

  • Authorization: Auth String(详情请参见 请求签名 文档)。
  • 通过子账号使用时,需要授予相关的权限,详情请参见 授权粒度详情 文档。

请求头

公共头部

该请求操作的实现使用公共请求头,了解公共请求头详情请参见 公共请求头部 文档。

非公共头部

该请求操作无特殊的请求头部信息。

请求体

该请求操作的实现需要有如下请求体。

<Request>
    <Input>
        <Object></Object>
    </Input>
    <Name></Name>
</Request>

具体数据描述如下:

节点名称(关键字) 父节点 描述 类型 是否必选
Request 保存请求的容器 Container


Container 类型 Request 的具体数据描述如下:

节点名称(关键字) 父节点 描述 类型 必选
Input Request 输入参数 Container
Name Request 模板名称 String
CategoryIds Request 模板分类 ID,支持传入多个,以 , 符号分割字符串 String


Container 类型 Input 的具体数据d描述如下:

节点名称(关键字) 父节点 描述 类型 必选 默认值 限制
Object Request.Input COS 桶中 PSD 文件,大小限制100M String

响应

响应头

公共响应头

该响应包含公共响应头,了解公共响应头详情请参见 公共响应头部 文档。

特有响应头

该响应无特殊的响应头。

响应体

该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:

<Response>
    <RequestId></RequestId>
    <Template>
        <Info>
            <Backgroud></Backgroud>
            <EXPIRY></EXPIRY>
            <MM></MM>
            <YY></YY>
            <base></base>
        </Info>
        <TemplateId></TemplateId>
    </Template>
</Response>

具体的数据内容如下:

节点名称(关键字) 父节点 描述 类型
Response 保存结果的容器 Container


Container 节点 Response 的内容:

节点名称(关键字) 父节点 描述 类型
RequestId Response 请求 ID Container
Template Response 解析出的 PSD 文件的具体内容 Container


Container 节点 Template 的内容:

节点名称(关键字) 父节点 描述 类型
Info Response 模板内容 Container
TemplateId Response 模板 ID String

错误码

该请求无特有错误信息,常见的错误信息请参见 错误码 文档。

实际案例

请求

POST /template HTTP/1.1
Authorization:q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR98****-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0e****
Host:test-1234567890.ci.ap-chongqing.myqcloud.com
Content-Length: 1666
Content-Type: application/xml

<Request>
    <Input>
        <Object>demo.psd</Object>
    </Input>
    <Name></Name>
    <CategoryIds>61849dcf18044201b378f699,61849dcf18044201b378f69b</CategoryIds>
</Request>

响应

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 100
Connection: keep-alive
Date: Thu, 14 Jul 2022 12:37:29 GMT
Server: tencent-ci
x-ci-request-id: NjMxMDJhYTNfMThhYTk0MGFfYmU1OV8zZjc=

<Response>
    <RequestId>NjMxMDJhYTNfMThhYTk0MGFfYmU1OV8zZjc=</RequestId>
    <Template>
        <Info>
            <Background>https://background.png</Background>
            <EXPIRY>EXPIRY</EXPIRY>
            <MM>MM</MM>
            <YY>YY</YY>
            <base>https://example.png</base>
        </Info>
        <TemplateId>634f9a1a412c273727f440fd</TemplateId>
    </Template>
</Response>

目录