开放平台

用 API Key 安全读取你自己的账户资料、订单和反馈,接入你常用的工具与工作流。

开发者编写程序

API 凭据

API Key 决定开放接口能读到哪些数据。每个 Key 只属于你本人,只能读取你自己的资料、订单和反馈。

正在加载凭据…

接口参考

开放接口全部为只读 GET 请求,使用 X-API-Key 请求头认证。

认证

在请求头中携带 API Key。服务端只保存 Key 的摘要,无法还原明文。

请求头
X-API-Key
curl "https://data.kuaiyizhi.cn/api/open/v1/me" \
  -H "X-API-Key: ky_live_<your-key>"

curl "https://data.kuaiyizhi.cn/api/open/v1/orders?page=1&pageSize=20" \
  -H "X-API-Key: ky_live_<your-key>"

端点

  • GET/api/open/v1/me

    返回账号 ID、邮箱、邮箱验证状态、账号状态、注册时间与最后登录时间。

  • GET/api/open/v1/orders

    按创建时间倒序返回订单号、课程 ID、金额、状态、支付方式和时间。不含交易号与预支付信息。

  • GET/api/open/v1/feedbacks

    返回你提交的反馈及处理状态和管理员回复。不包含内部元数据与页面 URL。

分页与筛选

列表接口支持分页,反馈接口额外支持按类型和状态筛选。

参数适用接口说明
pageorders, feedbacks页码,默认为 1。
pageSizeorders, feedbacks每页条数,默认 20,范围 1 到 100。
typefeedbacks反馈类型:bug、feature、suggestion、question、other。
statusfeedbacks反馈状态:pending、reviewed、resolved、closed。

响应格式

成功时 data 下包含结果数组与 pagination 对象;失败时返回 success 与 error。

{
  "success": true,
  "data": {
    "orders": [ /* … */ ],
    "pagination": {
      "page": 1,
      "pageSize": 20,
      "totalCount": 42,
      "totalPages": 3,
      "hasNextPage": true,
      "hasPrevPage": false
    }
  }
}

错误码

  • 400分页或筛选参数不合法。
  • 401Key 缺失、无效或已撤销。
  • 403账号不可用。