网盘更新中心 API 接口文档

版本 v2.0 | 最后更新:2026-5-15

概述与认证方式

本文档描述了网盘更新中心系统的全部API接口,供开发者集成使用。

所有API响应均为JSON格式,Content-Type为 application/json; charset=UTF-8

认证方式

本系统支持以下三种认证方式:

认证方式说明适用场景
Cookie认证 用户通过Web端登录后自动获得Cookie,请求时自动携带 Web前端、同域请求
API密钥认证 在请求参数中携带 api_key 参数,值为用户的API密钥 第三方应用、CLI工具
Token认证 通过 user_token 参数或 Authorization: Bearer <token> 请求头传递 App开发、跨域请求

通用响应格式

{
  "code": 0,
  "msg": "操作成功",
  "data": { ... }
}

其中 code=0 表示成功,负数表示各类错误。

错误码说明

错误码含义处理建议
0操作成功正常处理响应数据
-1通用错误 / 参数错误检查请求参数是否符合要求
-4功能未开启 / 未知操作确认API开关已打开或action参数正确
-5账号已被禁用联系管理员解封账号
-6认证失败检查Token或API密钥是否正确

用户认证接口

接口文件: api_v2.php | 不需要认证的接口: 登录、注册

POST api_v2.php?action=login

用户登录

使用用户名和密码登录,返回用户Token。

参数名类型必填说明
usernameString用户名,4-20位字母数字下划线
passwordString登录密码
返回示例
{
  "code": 0,
  "msg": "登录成功",
  "data": {
    "uid": 1,
    "username": "demo",
    "nickname": "demo",
    "email": "demo@example.com",
    "level": 0,
    "storage_used_mb": 15.23,
    "storage_limit_mb": 100,
    "traffic_used_mb": 45.6,
    "traffic_limit_mb": 500,
    "api_key": "a1b2c3d4...",
    "user_token": "enc_token_string",
    "token_expire": 1715731200,
    "register_time": "2024-01-01 12:00:00"
  }
}
POST api_v2.php?action=register

用户注册

注册新用户账号,成功后自动返回Token。

参数名类型必填说明
usernameString用户名,4-20位字母数字下划线
passwordString密码,6-32位
nicknameString昵称,不超过20字符,默认同用户名
emailString邮箱地址
返回示例
{
  "code": 0,
  "msg": "注册成功",
  "data": {
    "uid": 2,
    "username": "newuser",
    "nickname": "新用户",
    "api_key": "a1b2c3d4...",
    "user_token": "enc_token_string",
    "token_expire": 1715731200,
    "storage_limit_mb": 100,
    "traffic_limit_mb": 500
  }
}
GET api_v2.php?action=profile

获取用户资料

获取当前登录用户的详细资料信息。需要认证。

返回示例
{
  "code": 0,
  "data": {
    "uid": 1,
    "username": "demo",
    "nickname": "demo",
    "email": "demo@example.com",
    "level": 0,
    "enable": 1,
    "api_key": "a1b2c3d4...",
    "storage_used_mb": 15.23,
    "storage_limit_mb": 100,
    "traffic_used_mb": 45.6,
    "traffic_limit_mb": 500,
    "register_time": "2024-01-01 12:00:00",
    "last_login_time": "2024-05-01 08:30:00"
  }
}
POST api_v2.php?action=update_profile

更新用户资料

更新当前用户的昵称和邮箱。需要认证。

参数名类型必填说明
nicknameString新昵称,不超过20字符
emailString新邮箱地址
POST api_v2.php?action=change_password

修改密码

修改当前用户的登录密码。需要认证。

参数名类型必填说明
old_passwordString旧密码
new_passwordString新密码,6-32位
GET api_v2.php?action=api_key_info

获取API密钥

获取当前用户的API密钥,如果尚未生成则自动创建。需要认证。

POST api_v2.php?action=regenerate_api_key

重新生成API密钥

重新生成API密钥,旧的密钥将立即失效。需要认证。

文件上传接口

POST api.php

简单文件上传

通过 multipart/form-data 格式直接上传文件。这是最简单的上传方式。

参数名类型必填说明
fileFile待上传的文件(multipart格式)
showInt是否首页显示,1显示0隐藏,默认1
ispwdInt是否设置下载密码,1设置0不设置
pwdString下载密码(ispwd=1时必填),仅支持字母和数字
folder_idInt目标文件夹ID(需登录)
api_keyStringAPI密钥,用于身份认证
formatString返回格式: json(默认) / jsonp / form
callbackStringJSONP回调函数名(format=jsonp时)
返回示例(成功)
{
  "code": 0,
  "msg": "文件上传成功!",
  "hash": "f1e807cb0d6ba52d71bdb02864e6ba8",
  "name": "example.jpg",
  "size": 58937,
  "type": "jpg",
  "id": 123,
  "downurl": "https://pan.fosare.com/down.php?hash=...",
  "viewurl": "https://pan.fosare.com/view.php?hash=...jpg"
}
返回示例(文件已存在)
{
  "code": 0,
  "msg": "本站已存在该文件",
  "exists": 1,
  "hash": "...",
  "name": "example.jpg",
  "size": 58937,
  "type": "jpg",
  "id": 123,
  "downurl": "https://pan.fosare.com/down.php?hash=..."
}
POST ajax.php?act=pre_upload

预上传检查(大文件分块上传第一步)

在大文件上传前进行检查,包括文件大小限制、格式限制、配额检查等。需要CSRF Token。

参数名类型必填说明
csrf_tokenStringCSRF Token
nameString文件名
hashString文件MD5(32位hex)
sizeInt文件大小(字节)
showInt是否首页显示
ispwdInt是否设置密码
pwdString下载密码
folder_idInt目标文件夹ID
返回示例(需要分块上传)
{
  "code": 0,
  "third": false,
  "hash": "...",
  "chunksize": 8388608,
  "chunks": 3
}
POST ajax.php?act=upload_part

分块上传(大文件分块上传第二步)

上传文件的单个分块。每块大小由pre_upload返回的chunksize决定(默认8MB)。

参数名类型必填说明
fileFile当前分块的文件数据
hashString文件MD5
chunkInt当前分块编号(从1开始)
POST ajax.php?act=complete_upload

完成上传(通过第三方云存储上传后使用)

当使用第三方云存储直接上传后,调用此接口通知服务端完成数据入库。

参数名类型必填说明
hashString文件MD5
POST folder_api.php?act=simple_upload

简易上传(文件夹内)

在指定文件夹内快速上传文件。需要认证。

参数名类型必填说明
fileFile待上传的文件
folder_idInt目标文件夹ID

文件管理接口

接口文件: api_v2.php | 所有接口需要认证

GET api_v2.php?action=file_list

获取文件列表

获取当前用户上传的文件列表,支持分页和排序。

参数名类型必填说明
pageInt页码,默认1
limitInt每页数量,默认20,最大100
folder_idInt文件夹ID筛选,0或省略表示全部文件
sortString排序字段: id/name/size/addtime/count,默认id
orderString排序方向: ASC/DESC,默认DESC
返回示例
{
  "code": 0,
  "data": {
    "page": 1,
    "limit": 20,
    "total": 85,
    "total_page": 5,
    "list": [
      {
        "id": 123,
        "name": "example.jpg",
        "type": "jpg",
        "size": 58937,
        "size_formatted": "57.6 KB",
        "hash": "f1e807cb...",
        "addtime": "2024-05-01 12:00:00",
        "hide": 0,
        "folder_id": 0,
        "download_count": 12,
        "download_url": "https://pan.fosare.com/down.php?hash=...",
        "view_url": "https://pan.fosare.com/view.php?hash=...jpg"
      }
    ]
  }
}
GET api_v2.php?action=file_info

获取文件详情

获取单个文件的详细信息,通过ID或Hash查询。

参数名类型必填说明
idInt二选一文件ID
hashString二选一文件MD5 Hash(32位hex)
GET api_v2.php?action=file_search

搜索文件

根据关键词搜索用户的文件。

参数名类型必填说明
kwString搜索关键词
typeString文件类型筛选,多个用逗号分隔
pageInt页码,默认1
limitInt每页数量,默认20,最大100
POST api_v2.php?action=file_rename

重命名文件

参数名类型必填说明
file_idInt文件ID
new_nameString新文件名
POST api_v2.php?action=file_delete

删除文件

参数名类型必填说明
file_idInt文件ID
POST api_v2.php?action=file_toggle_hide

切换文件显示/隐藏

参数名类型必填说明
file_idInt文件ID

文件夹管理接口

接口文件: folder_api.php / api_v2.php | 需要认证

GET api_v2.php?action=folder_list

获取文件夹列表

参数名类型必填说明
parent_idInt父文件夹ID,0表示根目录,默认0
POST api_v2.php?action=folder_create

创建文件夹

参数名类型必填说明
nameString文件夹名称,不超过50字符
parent_idInt父文件夹ID,默认0(根目录)

完整文件夹操作(通过 folder_api.php)

以下操作通过 folder_api.php 实现,支持的操作:

act参数说明关键参数
create创建文件夹name, parent_id
rename重命名文件夹folder_id, new_name
delete删除文件夹folder_id
batch_delete批量删除folder_ids, file_ids
sort排序文件夹folder_id, sort(1-999)
move移动文件/文件夹target_id, folder_ids, file_ids
list获取文件夹内容parent_id, kw
get_share_info获取文件夹分享信息folder_id
set_share设置文件夹分享folder_id, share_need_pwd, share_pwd, share_notice
rename_file重命名文件file_id, new_name
get_password获取文件密码file_id
set_password设置文件密码file_id, password
batch_rename批量重命名file_ids, pattern
batch_copy批量复制file_ids, target_id
transfer转存文件/文件夹url, password, target_folder
transfer_preview转存预览url
get_file_share_info获取文件分享信息file_id
set_file_share设置文件分享file_id, share_type, share_notice

分享管理接口

接口文件: api_v2.php | 需要认证

POST api_v2.php?action=share_create

创建分享链接

为指定文件生成分享链接。

参数名类型必填说明
file_idInt文件ID
返回示例
{
  "code": 0,
  "msg": "分享链接创建成功",
  "data": {
    "share_key": "a1b2c3d4e5f6g7h8",
    "share_link": "https://pan.fosare.com/share.php?key=a1b2c3d4e5f6g7h8",
    "direct_link": "https://pan.fosare.com/file.php?hash=..."
  }
}
GET api_v2.php?action=share_info

获取分享信息

参数名类型必填说明
file_idInt文件ID
POST api_v2.php?action=share_revoke

撤销分享链接

参数名类型必填说明
file_idInt文件ID

统计查询接口

接口文件: api_v2.php | 需要认证

GET api_v2.php?action=stats_summary

获取综合统计

获取当前用户的存储、流量、文件、文件夹综合统计数据。

返回示例
{
  "code": 0,
  "data": {
    "storage": {
      "used_bytes": 15728640,
      "used_mb": 15.0,
      "limit_mb": 100,
      "limit_bytes": 104857600,
      "is_unlimited": false,
      "usage_percent": 15.0
    },
    "traffic": {
      "used_bytes": 52428800,
      "used_mb": 50.0,
      "limit_mb": 500,
      "limit_bytes": 524288000,
      "is_unlimited": false,
      "usage_percent": 10.0,
      "reset_interval_days": 30
    },
    "files": {
      "total_count": 85,
      "today_uploads": 3,
      "total_downloads": 452
    },
    "folders": {
      "total_count": 5
    }
  }
}
GET api_v2.php?action=disk_usage

获取磁盘使用详情

获取存储空间详细使用情况,包含按文件类型的分类统计。

GET api_v2.php?action=traffic_logs

获取流量日志

获取用户的流量消耗日志记录。

参数名类型必填说明
pageInt页码,默认1
limitInt每页数量,默认20,最大100
daysInt查询最近N天,默认7天,最大90天

卡密兑换接口

接口文件: api_v2.php | 需要认证

POST api_v2.php?action=redeem

兑换卡密

使用卡密代码兑换存储空间和流量配额。

参数名类型必填说明
card_codeString卡密代码
返回示例
{
  "code": 0,
  "msg": "兑换成功",
  "data": {
    "storage_added_mb": 50,
    "traffic_added_mb": 100,
    "resource_info": { ... }
  }
}
GET api_v2.php?action=redeem_history

获取兑换记录

参数名类型必填说明
pageInt页码,默认1
limitInt每页数量,默认20,最大100