模版装修-得到可以增加的section列表
主题 Liquid - 获取 DIY 导航添加模块:获取 DIY 主题装修中可添加到页面的模块(sections)列表。包含所有可用模块的基本信息:类型名称、分类、多语言名称、card_type、预设 blocks 结构等。
接口信息
- 接口地址:
{your-site-url}/api/skill/theme-liquid/get-diy-navigation-add-sections
- 基础 URL:
{your-site-url} 需替换为你自己的独立站 URL 地址,如 https://your-domain.com/apimanager666
- 请求方式:
POST
认证
请求头中需要携带 skill-access-token:
| Header |
值 |
skill-access-token |
{your-skill-access-token} (请替换为你自己的 token) |
Content-Type |
application/json |
请求参数 (JSON Body)
| 字段 |
类型 |
必填 |
说明 |
theme_id |
string |
是 |
主题 ID |
sections_type |
string |
是 |
要获取的 section 分组名称。可选值:header-group(头部)、content_for_layout(内容区)、footer-group(底部) |
page_type |
string |
是 |
页面类型,如 home、product 等 |
请求示例
请求体 JSON
{
"theme_id": "832",
"sections_type": "header-group",
"page_type": "home"
}
cURL
curl --location --request POST '{your-site-url}/api/skill/theme-liquid/get-diy-navigation-add-sections' \
--header 'skill-access-token: {your-skill-access-token}' \
--header 'Content-Type: application/json' \
--data-raw '{"theme_id":"832","sections_type":"header-group","page_type":"home"}'
返回结果
code 为 200 表示调用成功;code 不为 200 表示调用失败。
成功响应
{
"code": 200,
"data": {
"sections": {
"section_arr": [
"affiliate-banner-card",
"banner-with-slider",
"blog-posts",
"cascading-collection",
"cascading-product",
"collection-list",
"collage-tabs",
"collapsible-tabs",
"contact-form",
"countdown-timer",
"custom-code",
"custom-content",
"empty-space",
"featured-collection",
"gallery",
"hotspots-image",
"icon-box",
"image-with-text",
"newsletter",
"product-bundles",
"product-tabs",
"promotion-banner",
"rich-text",
"slider",
"testimonials",
"video-hero",
"video"
],
"groups": {
"empty_category": {
"category": "",
"sections": []
},
"6477351f...": {
"category": {
"text": "插件",
"lang_params": { "en": "Plugin", "tw": "插件" }
},
"sections": []
},
"7f722e54...": {
"category": {
"text": "专辑",
"lang_params": { "en": "Collection", "tw": "專輯" }
},
"sections": []
}
}
}
},
"message": "success"
}
返回字段说明
| 字段 |
类型 |
说明 |
code |
Number |
状态码,200 表示成功 |
message |
String |
执行结果的文字描述 |
data |
Object |
模块数据 |
data → sections 字段
| 字段 |
类型 |
说明 |
section_arr |
Array[string] |
所有可用 section 的 type 名称列表(仅名称,不含详情) |
groups |
Object |
按分类分组的可用 sections 详情。key 为分组 ID(空字符串 key empty_category 表示未分类),value 为分组对象 |
groups 分组对象字段
| 字段 |
类型 |
说明 |
category |
Object/string |
分类名称(多语言对象)。empty_category 分组此字段为空字符串 "" |
sections |
Array[Object] |
该分类下的 section 列表 |
category 对象字段(多语言)
| 字段 |
类型 |
说明 |
text |
string |
分类默认语言名称 |
lang_params |
Object |
分类多语言翻译,key 为语言简码,value 为翻译文本 |
section 子项字段
| 字段 |
类型 |
说明 |
type |
string |
section 类型标识,对应 section_arr 中的值 |
name |
Object |
section 显示名称(多语言对象,结构同 category) |
card_type |
string |
section 卡片类型。常见值:static(静态内容)、dynamic(动态数据,如专辑/商品)、form(表单)、css(CSS 代码)、addon(插件)、空字符串(特殊情况) |
category |
Object/string |
所属分类(多语言对象),与父级 groups 的 category 一致。empty_category 下的 section 此字段为 "" |
settings |
Object |
section 的预设配置项,结构因 type 而异 |
blocks |
Array[Object] |
section 的子块列表,结构因 type 而异 |
blocks 子项通用字段
| 字段 |
类型 |
说明 |
type |
string |
block 类型标识,含义因所属 section 的 type 而异 |
settings |
Object |
block 的预设配置项,结构因 block 的 type 而异 |
已知 card_type 说明
| card_type |
含义 |
static |
静态内容模块(文字、图片、按钮等) |
dynamic |
动态数据模块(绑定专辑、商品等数据源) |
form |
表单模块(联系表单、邮件订阅等) |
css |
CSS 代码模块 |
addon |
插件模块(第三方插件提供的 section) |
"" |
无特殊类型标记 |
注意事项
sections_type 决定返回哪个区域的可用模块,不同区域可用的模块可能不同
section_arr 是本节所有可用 section 类型的汇总名称列表
groups 中按分类组织 section 详情。empty_category(key 为空字符串)包含未归类的 section
settings 和 blocks[].settings 结构因 section 类型而异,添加 section 时需要提供完整的 settings 结构
- 多语言字段(
name、category)结构为 { text: "默认文本", lang_params: { "en": "...", "tw": "..." } }
- 获取到的 section 详情可用于构建"添加模块"的请求体,将选中的 section 数据提交到
set-diy-navigation 或类似 API