Fecify-应用-列表

接口信息

  • 接口地址: {your-site-url}/api/skill/addons/list
  • 基础 URL: {your-site-url} 需替换为你自己的独立站 URL 地址，如 https://your-domain.com/admin
  • 请求方式: GET
  • Content-Type: application/json
  • 说明: 获取应用（插件/模版）分页列表，支持按应用类型、安装状态、上架状态和应用类别筛选。

认证

请求头中需要携带 skill-access-token：

Header 值
skill-access-token {your-skill-access-token} （请替换为你自己的 token）

请求参数

参数 类型 必填 说明
pageNum Number 否 当前页码，默认 1
pageSize Number 否 每页条数，默认 20
type Number 否 应用类型，通过 Fecify-插件类型列表 获取
install_status Number 否 安装状态，通过 Fecify-插件安装状态 获取：1 已安装，2 未安装，3 安装中
status Number 否 上架状态：1 上架，2 下架
addons_type Number 否 应用类别：1 应用插件，2 模版。一般情况下需要设置此参数

请求示例

cURL

curl --location --request GET '{your-site-url}/api/skill/addons/list?pageNum=1&pageSize=10&type=1&install_status=1&status=1&addons_type=1' \
--header 'skill-access-token: {your-skill-access-token}' \
--header 'Content-Type: application/json'

返回结果

code 为 200 表示调用成功；code 不为 200 表示调用失败。

成功响应

{
    "code": 200,
    "data": {
        "list": [
            {
                "id": 156,
                "identity": "orderinvoice",
                "name": "订单发票invoice",
                "type": 1,
                "img": "/system/addons/orderinvoice.png",
                "description": "已支付订单，生成pdf格式的invoice发票文件",
                "status": 1,
                "install_status": 1,
                "version": "1.0.0",
                "updated_at": "2022-03-31 16:44:27",
                "created_at": "2022-03-31 16:44:27",
                "pay_type": 2,
                "shoptypes": [
                    {
                        "addons_id": 156,
                        "shop_type": 10
                    }
                ],
                "docurl": "https://www.fecify.com/doc/cn-1.0/fecify-merchant-order-invoice.html",
                "videourl": "https://www.bilibili.com/video/BV13HZEY9Ej2"
            }
        ],
        "total": 31,
        "pageSize": 10,
        "totalPage": 4
    },
    "message": "success"
}

返回字段说明

字段 类型 说明
code Number 状态码，200 表示成功
message String 执行结果的文字描述
data Object 返回数据

data 子字段

字段 类型 说明
list Array 应用列表
total Number 总记录数
pageSize Number 每页条数
totalPage Number 总页数

list 子项

字段 类型 说明
id Number 应用 ID
identity String 应用唯一标识
name String 应用名称
type Number 应用类型编码，对应 Fecify-插件类型列表 的 key
img String 应用图片相对路径
description String 应用描述
status Number 上架状态：1 上架，2 下架
install_status Number 安装状态：1 已安装，2 未安装，3 安装中
version String 应用版本号
updated_at String 更新时间，格式 YYYY-MM-DD HH:mm:ss
created_at String 创建时间
pay_type Number 付费类型：1 付费应用，2 免费应用
shoptypes Array 支持的店铺类型列表
docurl String 应用文档链接
videourl String 应用视频链接

shoptypes 子项

字段 类型 说明
addons_id Number 应用 ID
shop_type Number 店铺类型：10 B2C，20 B2B

注意事项

  1. addons_type 参数区分应用插件和模版，一般需要设置。
  2. type 参数通过 Fecify-插件类型列表 获取下拉选项。
  3. install_status 参数通过 Fecify-插件安装状态 获取下拉选项。
  4. img 为相对路径，完整 URL 需拼接基础图片 URL。

results matching ""

    No results matching ""