获取模板列表

更新时间 2025/02/25 05:40:11

英飞画布服务端支持基于 Restful API 获取通过开发者门户创建的模板列表信息。

前提条件

• 已经完成英飞画布应用的创建动作，详见新人指引文档。
• 了解 REST API 请求的认证方式，详见获取 Access Token 文档。

请求路径

https://developer.infi.cn/infi/api/v1/templates

请求 curl 示例

curl --location --request GET \
      --header 'token: YOUR_ACCESS_TOKEN' \
      --header 'Content-Type: application/json' \
      https://developer.infi.cn/infi/api/v1/templates

请求成功情况

响应的 Http 状态码为 200 时表示请求成功，并会返回模板列表信息。

请求成功返回数据示例如下:

{
    "total": 1,
    "list": [
        {
            "templateId": "TEMPLATE_ID",
            "recordId": "RECORD_ID",
            "templateName": "TEMPLATE_NAME",
            "creatorId": "CREATOR_ID",
            "createdAt": 1740213011086,
            "creatorName": "CREATOR_NAME",
            "coverImg": "COVER_IMG",
            "coverSvg": "COVER_SVG"
        }
    ]
}

返回结果数据字段说明如下:

• total: 模板总数量。
• list: 模板列表。
• list.templateId: 模板 ID。
• templateItem.recordId: 模板关联的画布 ID。
• templateItem.templateName: 模板名称。
• templateItem.creatorId: 创建者 ID。
• templateItem.createdAt: 创建时间。
• templateItem.creatorName: 创建者名称。
• templateItem.coverImg: 模板封面图片。模板内容为空时，该字段为空。
• templateItem.coverSvg: 模板封面 SVG。模板内容为空时，该字段为空。

请求失败情况

响应的 Http 状态码不为 200 时表示请求失败，如需更多信息请参考请求错误说明文档。