管理自定义静态模板

准备工作

获取访问令牌。请参阅 “管理主题 ”。

管理模板文件注册

注册模板文件

curl -X POST 'https://<tenant>/template/v1.0/branding/registration/<type>' --header 'Authorization: Bearer <access_token>' -F 'file=@"<file>"'

此命令用于注册一个模板文件。下表列出了允许的文件类型。

允许的类型	允许的文件扩展名	每种类型的文件最大数量	每个文件的最大大小
js	.js	15	300 KB
CSS	.css	15	100 KB
图标	.ico、.png 和.svg	30	100 KB
图像	.png、.jpg、.jpeg、.gif、.svg 和.webp	15	500 KB
字体	.woff、.woff2、.ttf、.otf 和.eot	15	500 KB

获取某类型的所有模板文件

curl -X GET 'https://<tenant>/template/v1.0/branding/registration/<type>' -H 'Authorization: Bearer <access_token>'

此命令列出所有已注册到特定文件类型的文件。

删除模板文件

curl -X DELETE 'https://<tenant>/template/v1.0/branding/registration/<type>/<file_name>' --header 'Authorization: Bearer <access_token>'

此命令用于删除现有文件。

删除某类型下的所有模板文件

curl -X DELETE 'https://<tenant>/template/v1.0/branding/registration/<type>' --header 'Authorization: Bearer <access_token>'

此命令将删除所有已注册为指定文件类型的文件。

自定义模板文件

模板文件注册后，您可以对其进行更新。要修改现有的模板文件，请参阅以下页面：

注意：如果网页在更新文件后仍通过 API 路径 /template/v1.0/static 引用该文件，更改可能不会立即显示。请清除浏览器缓存，并等待最多 5 分钟以便更新生效。

在 HTML 中使用已注册的文件

对于一个 .js 文件，请注册该 <js-filename> 文件，并将其添加到 HTML 页面中：

<script type="text/javascript" src="/template/v1.0/static/js/<js-filename>?themeId=@THEME_ID@"></script>

对于图像文件 ，请注册该 <image-filename> 文件，并将其添加到 HTML 页面中：

<img src="/template/v1.0/static/assets/image/<image-filename>?themeId=@THEME_ID@">

对于图标文件 ，请注册该 <icon-filename> 文件，并将其添加到 HTML 页面中：

<link rel="icon" href="/template/v1.0/static/assets/icon/<icon-filename>?themeId=@THEME_ID@">

对于一个 .css 文件，请注册该 <css-filename> 文件，并将其添加到 HTML 页面中：

<link rel="stylesheet" href="/template/v1.0/static/assets/css/<css-filename>?themeId=@THEME_ID@">

<css-filename>对于字体文件 ，请将其包含在文件中 .css ：

@font-face {   
    font-family: '<font-family>';   
    src: url('/template/v1.0/static/assets/fonts/<font-filename>?themeId=@THEME_ID@') format('<font-format>')
}


.custom-text {   
    font-family: '<font-family>'
}

<css-filename>注册字体文件 <font-filename> 和文件 .css 后，将其添加到 HTML 页面中：

<link rel="stylesheet" href="/template/v1.0/static/assets/css/<css-filename>?themeId=@THEME_ID@" />

注： @THEME_ID@ 是一个代表主题 ID 的宏。它将在运行时被替换为实际的 themeId。