Gerenciamento de modelos estáticos personalizados

Antes de começar

Obtenha um token de acesso. Consulte "Gerenciamento de temas".

Gerenciar o registro de arquivos de modelo

Registrar um arquivo de modelo

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

Este comando registra um arquivo de modelo. A tabela abaixo apresenta os tipos de arquivo permitidos.

Tipos permitidos	Extensões de arquivo permitidas	Número máximo de arquivos por tipo	Tamanho máximo por arquivo
js	.js	15	300 KB
CSS	.css	15	100 KB
ícone	.ico,.png e.svg	30	100 KB
imagem	.png,.jpg,.jpeg,.gif,.svg e.webp	15	500 KB
fonte	.woff,..woff2,.ttf,.otf e.eot	15	500 KB

Obter todos os arquivos de modelo de um determinado tipo

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

Este comando lista todos os arquivos associados a esse tipo específico de arquivo.

Excluir um arquivo de modelo

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

Este comando exclui um arquivo existente.

Excluir todos os arquivos de modelo de um tipo

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

Este comando exclui todos os arquivos registrados com esse tipo específico de arquivo.

Personalizar um arquivo de modelo

É possível atualizar um arquivo de modelo após o seu registro. Para modificar um arquivo de modelo existente, consulte as seguintes páginas:

Observação: Se a página da Web fizer referência ao arquivo por meio do /template/v1.0/static caminho da API após a atualização, as alterações podem não aparecer imediatamente. Limpe o cache do seu navegador e aguarde até 5 minutos para que a atualização seja aplicada.

Usando um arquivo registrado em HTML

Para criar um .js arquivo, salve-o <js-filename> e insira-o na página HTML:

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

Para um arquivo de imagem, salve o <image-filename> arquivo e insira-o na página HTML:

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

Para um arquivo de ícone, registre o <icon-filename> arquivo e insira-o na página HTML:

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

Para criar um .css arquivo, salve-o <css-filename> e insira-o na página HTML:

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

<css-filename>Para um arquivo de fonte, inclua-o no arquivo .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>Depois de registrar o arquivo <font-filename> da fonte e o .css arquivo, insira-o na página HTML:

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

Nota: @THEME_ID@ é uma macro que representa o ID do tema. Ele é substituído pelo themeId real durante a execução.