版本 2.4.7.20261116085428 · 最新

套餐分组 package-groups

把套餐分组展示,便于客户选购。

点击任一接口,右侧显示对应的调用示例。

套餐鉴权: 仅管理员6 个接口

鉴权

请求头带 X-API-Key(在「API 密钥」页开通,密钥只在开通时显示一次);也可用登录得到的 Authorization: Bearer 令牌。

X-API-Key

鉴权失败回 401;无权回 403(code 为 insufficient_scope 等)。

约定

分页参数 page(从 1 起)、page_size;排序 sort=字段 或 -字段。

时间一律 RFC 3339(UTC);金额单位为分。

写操作成功回 200/201/204;重复提交按资源唯一键回 409。

GET/api/v2/package-groups列出套餐分组

鉴权: 仅管理员

查询参数

字段类型说明
pageinteger 页码,从 1 开始。
默认 1
page_sizeinteger 每页条数。
默认 20
sortstring 排序字段,逗号分隔,前缀 `-` 表示降序,如 `-created_at,id`。
POST/api/v2/package-groups创建套餐分组

鉴权: 仅管理员

请求体 application/json

字段类型说明
desstring 备注说明
name必填string 名称
sortinteger 排序值(小的在前)。
POST/api/v2/package-groups/order调整套餐分组顺序

鉴权: 仅管理员

请求体 application/json

字段类型说明
ids必填integer[] 分组 id,按新顺序排列。
PUT/api/v2/package-groups/{id}修改套餐分组

鉴权: 仅管理员

请求体 application/json

字段类型说明
desstring 备注说明
name必填string 名称
sortinteger 排序值(小的在前)。

套餐分组对象

字段类型说明
created_atstring 创建时间
只读
desstring 备注说明
idinteger 记录 ID
只读
ids必填integer[] 分组 id,按新顺序排列。
namestring 名称
sortinteger 排序值(小的在前)。
updated_atstring 更新时间
只读

返回与错误

成功直接回资源 JSON(HTTP 2xx);失败回 application/problem+json(code、detail,校验失败带 errors);列表为 items + total。

成功
{
  "id": 1,
  "name": "example"
}
列表
{
  "items": [
    {
      "id": 1
    }
  ],
  "page": 1,
  "page_size": 20,
  "total": 1
}
失败
{
  "code": "validation_failed",
  "detail": "请求参数不合法",
  "errors": [
    {
      "code": "required",
      "field": "/name",
      "message": "name 必填"
    }
  ],
  "request_id": "0123456789abcdef",
  "status": 422,
  "title": "Unprocessable Entity",
  "type": "about:blank"
}
开始使用

123

123