页面类型列表
接口信息
- 接口地址:
{your-site-url}/api/skill/base/page-types - 基础 URL:
{your-site-url}需替换为你自己的独立站 URL 地址,如https://your-domain.com/apimanager666 - 请求方式:
GET - 说明: 页面类型列表,返回的是前台商城的各个页面类型的信息。
认证
请求头中需要携带 skill-access-token:
| Header | 值 |
|---|---|
skill-access-token |
{your-skill-access-token} (请替换为你自己的 token) |
请求参数
无请求参数。
请求示例
cURL
curl --location --request GET '{your-site-url}/api/skill/base/page-types' \
--header 'skill-access-token: {your-skill-access-token}'
返回结果
code 为 200 表示调用成功;code 不为 200 表示调用失败。
成功响应
{
"code": 200,
"data": {
"home": {
"text": "首页",
"cn": "首页",
"tw": "首頁",
"en": "Home",
"handle": "",
"service": "home",
"sitelangs": "general,navigation,home",
"isdiypage": "1",
"code": "home"
},
"collection": {
"text": "商品专辑页",
"cn": "商品专辑页",
"tw": "商品專輯頁",
"en": "Product collection page",
"handle": "collections",
"service": "collection",
"sitelangs": "general,navigation,collection",
"isdiypage": "1",
"code": "collection"
},
"list-collections": {
"text": "专辑列表页",
"cn": "专辑列表页",
"tw": "专辑列表页",
"en": "list collections",
"handle": "list-collections",
"service": "collection",
"sitelangs": "general,navigation,collection",
"isdiypage": "1",
"code": "list-collections"
},
"search": {
"text": "搜索页面",
"cn": "搜索页面",
"tw": "搜尋頁面",
"en": "Search Page",
"handle": "search",
"service": "search",
"sitelangs": "general,navigation,search",
"isdiypage": "1",
"code": "search"
},
"product": {
"text": "商品详情页",
"cn": "商品详情页",
"tw": "商品詳情頁",
"en": "Product details page",
"handle": "products",
"service": "product",
"sitelangs": "general,navigation,product,coupon",
"isdiypage": "1",
"code": "product"
},
"inquiry": {
"text": "询价表",
"cn": "询价表",
"tw": "詢價表",
"en": "Inquiry Form",
"handle": "inquiry",
"service": "inquiry",
"sitelangs": "general,navigation,inquiry",
"isdiypage": "1",
"code": "inquiry"
},
"page": {
"text": "自定义页",
"cn": "自定义页",
"tw": "自訂頁",
"en": "Custom page",
"handle": "pages",
"service": "page",
"sitelangs": "general,navigation,page",
"isdiypage": "1",
"code": "page"
},
"blog_collection": {
"text": "博客专辑",
"cn": "博客专辑",
"tw": "部落格專輯",
"en": "Blog collection",
"handle": "blogs",
"service": "blogCollection",
"sitelangs": "general,navigation,blog",
"isdiypage": "1",
"code": "blog_collection"
},
"blog_article": {
"text": "博客文章",
"cn": "博客文章",
"tw": "部落格文章",
"en": "Blog article",
"handle": "blog",
"service": "blogArticle",
"sitelangs": "general,navigation,blog",
"isdiypage": "1",
"code": "blog_article"
},
"contacts": {
"text": "Constact",
"cn": "Constact",
"tw": "Contact",
"en": "Constact",
"handle": "contacts",
"service": "contacts",
"sitelangs": "general,navigation,contacts",
"isdiypage": "2",
"code": "contacts"
},
"coupon": {
"text": "优惠券折扣",
"cn": "优惠券折扣",
"tw": "優惠券折扣",
"en": "Coupon discount",
"handle": "coupon",
"service": "coupon",
"sitelangs": "general,navigation,coupon",
"isdiypage": "2",
"code": "coupon"
},
"mydiy": {
"text": "我的diy页",
"cn": "我的diy页",
"tw": "我的diy頁",
"en": "My diy page",
"handle": "mydiy",
"service": "mydiy",
"sitelangs": "general,navigation,mydiy",
"isdiypage": "2",
"code": "mydiy"
},
"not_found": {
"text": "404页",
"cn": "404页",
"tw": "404頁",
"en": "404 page",
"handle": "notfound",
"service": "notFound",
"sitelangs": "general,navigation,not_found",
"isdiypage": "2",
"code": "not_found"
},
"customer_order_checkout": {
"text": "用户订单-二次支付页面",
"cn": "用户订单-二次支付页面",
"tw": "用户订单-二次支付页面",
"en": "User order second checkout",
"handle": "customer_order_checkout",
"service": "customerOrderCheckout",
"sitelangs": "general,navigation,account",
"isdiypage": "2",
"code": "customer_order_checkout"
},
"affiliate": {
"text": "网盟商",
"cn": "网盟商",
"tw": "網聯商",
"en": "affiliate",
"handle": "affiliate",
"service": "affiliate",
"sitelangs": "general,navigation,affiliate",
"isdiypage": "2",
"code": "affiliate"
},
"rebate": {
"text": "满减活动",
"cn": "满减活动",
"tw": "滿減活動",
"en": "Full discount activities",
"handle": "rebate",
"service": "rebate",
"sitelangs": "general,navigation,rebate",
"isdiypage": "2",
"code": "rebate"
},
"seckill": {
"text": "限时促销",
"cn": "限时促销",
"tw": "限時促銷",
"en": "Flash Sale",
"handle": "seckill",
"service": "seckill",
"sitelangs": "general,navigation,seckill",
"isdiypage": "2",
"code": "seckill"
},
"review": {
"text": "评论列表",
"cn": "评论列表",
"tw": "評論列表",
"en": "Reviews",
"handle": "review",
"service": "review",
"sitelangs": "general,navigation",
"isdiypage": "2",
"code": "review"
}
},
"message": "success"
}
返回字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
code |
Number | 状态码,200 表示成功 |
message |
String | 执行结果的文字描述 |
data |
Object | 页面类型信息集合。key 为页面类型的 code,value 为该页面类型的信息对象 |
data 中每个页面类型信息对象的字段说明:
| 字段 | 类型 | 说明 |
|---|---|---|
text |
String | 页面类型名称(默认语言下的显示名称) |
cn |
String | 简体中文名称 |
tw |
String | 繁体中文名称 |
en |
String | 英文名称 |
handle |
String | 页面 URL 中使用的 handle(如 collections、products、pages;首页为空字符串) |
service |
String | 该页面类型对应的服务标识(如 home、collection、blogCollection、notFound 等) |
sitelangs |
String | 该页面使用的站点语言配置项,多个配置项用英文逗号分隔(如 general,navigation,home) |
isdiypage |
String | 是否支持 DIY 装修页面:1 = 支持,2 = 不支持 |
code |
String | 页面类型 code(与 data 的 key 一致) |
页面类型一览(data 的 key)
| code | 中文名称 | 说明 |
|---|---|---|
home |
首页 | 商城首页 |
collection |
商品专辑页 | 商品专辑(分类)页面 |
list-collections |
专辑列表页 | 专辑列表页面 |
search |
搜索页面 | 商品搜索页面 |
product |
商品详情页 | 商品详情页面 |
inquiry |
询价表 | 询价表单页面 |
page |
自定义页 | 自定义页面 |
blog_collection |
博客专辑 | 博客专辑(分类)页面 |
blog_article |
博客文章 | 博客文章详情页面 |
contacts |
Constact | 联系我们页面 |
coupon |
优惠券折扣 | 优惠券/折扣页面 |
mydiy |
我的diy页 | 用户 DIY 页面 |
not_found |
404页 | 404 错误页面 |
customer_order_checkout |
用户订单-二次支付页面 | 用户订单二次支付页面 |
affiliate |
网盟商 | 网盟商(affiliate)页面 |
rebate |
满减活动 | 满减活动页面 |
seckill |
限时促销 | 限时促销(Flash Sale)页面 |
review |
评论列表 | 评论列表页面 |
注意事项
- 无请求参数,直接调用即可返回全部页面类型。
data是对象而非数组,遍历时请使用Object.keys(data)或for...in获取页面类型 code。- 支持 DIY 装修的页面类型(
isdiypage为1):home、collection、list-collections、search、product、inquiry、page、blog_collection、blog_article;其余页面类型(isdiypage为2)不支持 DIY 装修。 - 该接口返回的页面类型信息可用于 模版装修-得到可装修页面类型信息 等装修相关接口的对照参考。