GuangYaPan

DANGER

Please use your account in a standardized manner. Do not use it for distribution services including but not limited to multi-person sharing, image hosting, software hosting and video external links to video websites for playback, as well as some other irregular uses not mentioned above. You will be responsible for the consequences of your account being blocked.

DANGER

请规范使用帐号，包含但不限于 多人共享使用、图床、软件床 和 视频外链到视频网站播放 等分发服务以及一些没有提到的不规范使用的方式导致帐号被封禁的，后果自负！

WARNING

This driver uses a two-stage SMS login. You need to provide a valid client_id before login. After completing the SMS login, access_token and refresh_token are saved automatically, and you can log in again with just access_token or refresh_token.

WARNING

该驱动使用两步短信登录。登录前需要提供有效的 client_id。短信登录完成后会自动保存 access_token 与 refresh_token，之后只需凭 access_token 或 refresh_token 即可再次登录。

1. Add in OpenList ​

1. 在 OpenList 中添加 ​

Client ID ​

客户端 ID ​

Required. Fill in the client_id for the GuangYaPan API. This field must be provided, otherwise storage initialization will fail.

必填。填入光鸭云盘 API 的 client_id，此项必须填写，否则存储初始化会失败。

Phone Number ​

手机号 ​

The phone number used for SMS login, e.g. +86 13800000000.

用于短信登录的手机号，例如 +86 13800000000。

Captcha Token ​

验证码令牌 ​

Captcha token required by /v1/auth/verification. Leave it empty if no captcha is triggered.

/v1/auth/verification 接口所需的验证码令牌。若未触发验证码可留空。

Send Code ​

发送验证码 ​

Set it to true and save to send the SMS code. It auto-resets to false after sending.

设为 true 并保存即可发送短信验证码，发送后会自动重置为 false。

Verify Code ​

短信验证码 ​

The SMS verification code you received. Fill it in and save to finish the login.

收到的短信验证码。填写后保存即可完成登录。

Verification ID ​

验证 ID ​

Auto-generated after sending the SMS code. Do not edit it manually.

发送短信验证码后自动生成，请勿手动修改。

Access Token ​

访问令牌 ​

Bearer access token. It is saved automatically after SMS login. If you already have a valid access_token or refresh_token, you can fill it directly instead of doing the SMS login.

Bearer 访问令牌。短信登录成功后会自动保存。如果已经持有有效的 access_token 或 refresh_token，可以直接填写而无需短信登录。

Refresh Token ​

刷新令牌 ​

Refresh token for auto-login and auto-refresh. Saved automatically after SMS login.

用于自动登录与自动刷新的刷新令牌，短信登录成功后会自动保存。

Root Folder Path ​

根文件夹路径 ​

Full path in the GuangYaPan cloud drive, e.g. /Movies/Anime. Leave it empty to use the root directory.

光鸭云盘中的完整路径，例如 /电影/动漫。留空则使用根目录。

Device ID ​

设备 ID ​

Optional custom device id (32 hex chars). Auto-generated when empty.

可选的自定义设备 ID（32 位十六进制字符），留空时自动生成。

Device Sign ​

设备签名 ​

Optional custom X-Device-Sign header. Generated from device_id when empty.

可选的自定义 X-Device-Sign 请求头，留空时根据 device_id 自动生成。

Page Size / Order By / Sort Type ​

分页大小 / 排序字段 / 排序方向 ​

  • Page Size: file list page size, default 100.
  • Order By: sort field used by the file list, options 0,1,2,3,4, default 3.
  • Sort Type: sort direction used by the file list, options 0,1, default 1.
  • 分页大小：文件列表每页数量，默认 100。
  • 排序字段：文件列表使用的排序字段，可选 0,1,2,3,4，默认 3。
  • 排序方向：文件列表使用的排序方向，可选 0,1，默认 1。

2. SMS Login Steps ​

2. 短信登录步骤 ​

  1. Fill in client_id and phone_number (and captcha_token if needed).
  2. Set send_code to true, then save. The storage will enter a "SMS sent" status and the verification_id is generated automatically.
  3. Fill in the received verify_code, then save again to finish the login. The access_token and refresh_token are saved automatically.
  1. 填写 client_id 与 phone_number（如需要同时填写 captcha_token）。
  2. 将 send_code 设为 true 并保存，存储会进入「短信已发送」状态，并自动生成 verification_id。
  3. 填写收到的 verify_code 后再次保存，即可完成登录，access_token 与 refresh_token 会自动保存。

3. Offline Download ​

3. 离线下载 ​

GuangYaPan supports calling its own offline download function from OpenList.

  1. Mount a GuangYaPan storage.
  2. In the backend Settings → Other, set the GuangYaPan temporary directory (choose any folder of this account).
  3. Go back to the frontend, enter the target folder, and choose GuangYaPan in the offline download option at the lower right corner.
  • Supports adding offline tasks via URL (e.g. http, magnet links).

光鸭云盘支持在 OpenList 中调用其自身的离线下载功能。

  1. 挂载光鸭云盘存储。
  2. 在后台 设置 → 其他 中设置光鸭云盘临时目录（选择本帐号任意文件夹）。
  3. 回到前端，进入目标文件夹，在右下角的离线下载选项中选择 GuangYaPan。
  • 支持通过链接（如 http、magnet）添加离线任务。

4. Precautions ​

4. 注意事项 ​

  • client_id is required, otherwise storage initialization will fail.
  • The verify_code is one-time use and will be cleared after a successful login.
  • The driver does not support overwriting uploads (same-name files will not overwrite).
  • Login priority: access_token → refresh_token → SMS login.
  • client_id 为必填项，否则存储初始化会失败。
  • verify_code 为一次性使用，登录成功后会被清空。
  • 该驱动不支持覆盖上传（同名文件不会覆盖）。
  • 登录优先级：access_token → refresh_token → 短信登录。

Contributors

Edit this page on GitHub

Last updated: