模版装修-模板文件内容-获取
读取指定店铺模板中某个文件的内容。使用前需先通过 模版装修-模板文件树 获取文件夹和文件列表。
接口信息
- 接口地址:
{your-site-url}/api/skill/theme-liquid/get-file-content
- 基础 URL:
{your-site-url} 需替换为你自己的独立站 URL 地址,如 https://your-domain.com/apimanager666
- 请求方式:
POST
- 说明: 获取指定店铺模板中某个文件的内容。
dir_name 和 file_name 需从 模版装修-模板文件树 获取。
认证
请求头中需要携带 skill-access-token:
| Header |
值 |
skill-access-token |
{your-skill-access-token} (请替换为你自己的 token) |
Content-Type |
application/json |
请求参数 (JSON Body)
| 字段 |
类型 |
必填 |
说明 |
theme_id |
string/int |
是 |
店铺模板 ID。从 店铺模版-列表 获取 |
dir_name |
string |
是 |
文件夹名称。从 模版装修-模板文件树 返回的文件夹名获取,可选值:assets、config、layout、locales、sections、snippets、templates |
file_name |
string |
是 |
文件名称。从文件树中对应文件夹下的文件名获取 |
请求示例
cURL
curl --location --request POST '{your-site-url}/api/skill/theme-liquid/get-file-content' \
--header 'skill-access-token: {your-skill-access-token}' \
--header 'Content-Type: application/json' \
--data-raw '{"theme_id":"832","dir_name":"layout","file_name":"theme.liquid"}'
返回结果
code 为 200 表示调用成功;code 不为 200 表示调用失败。
成功响应
{
"code": 200,
"data": {
"file_content": {
"id": 0,
"is_system": true,
"content": "{%- comment -%}\nThis is a comment block\n{%- endcomment -%}\n<!doctype html>\n<html lang=\"{{ shop.language_code }}\">\n<head>\n <meta charset=\"utf-8\">\n <title>{{ shop.meta_info.meta_title }}</title>\n {{ 'base.css' | asset_url | stylesheet_tag }}\n</head>\n<body>\n {% sections 'header-group' %}\n <div class=\"main-content\">\n {{ content_for_layout }}\n </div>\n {% sections 'footer-group' %}\n</body>\n</html>"
}
},
"message": "success"
}
返回字段说明
| 字段 |
类型 |
说明 |
code |
Number |
状态码,200 表示成功 |
message |
String |
执行结果的文字描述 |
data |
Object |
文件内容数据 |
data → file_content 字段
| 字段 |
类型 |
说明 |
id |
int |
文件 ID(原始文件为 0) |
is_system |
bool |
是否为系统原始文件。true = 系统原始文件(未修改过),false = 二次开发文件(已修改过) |
content |
string |
文件内容 |
注意事项
dir_name 和 file_name 需先从 模版装修-模板文件树 获取
dir_name 的有效值为文件树中的 7 个文件夹名:assets、config、layout、locales、sections、snippets、templates
is_system = true 表示返回的是系统原始文件内容;is_system = false 表示返回的是二次开发修改后的内容
- 读取文件内容后,可通过模板文件保存接口进行修改和保存