Skip to content

Commit bec9466

Browse files
okatu-loliokatu-loli
authored
docs(123_open): Add new guide for integrating 123 Open platform with Alist, covering setup and feature support. (#447)
1 parent dcc7a1a commit bec9466

File tree

3 files changed

+273
-0
lines changed

3 files changed

+273
-0
lines changed

‎docs/.vuepress/public/img/drivers/123/open/123_link.png‎

1.53 MB
Loading

‎docs/guide/drivers/123_open.md‎

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
---
2+
icon: iconfont icon-api
3+
order: 62
4+
category:
5+
- Guide
6+
tag:
7+
- Storage
8+
- Guide
9+
- 123 Open
10+
sticky: true
11+
star: true
12+
author: Qianshi (okatu-loli)
13+
---
14+
15+
# 123 Open (Open Platform)
16+
17+
`123 Open` is an open platform API provided by 123YunPan (123 Cloud Drive), which allows mounting and access within Alist using key-based authentication.
18+
19+
It supports file browsing, uploading, previewing, downloading, and file management. Alist also automatically maintains the token lifecycle.
20+
21+
::: warning Paid Features Required
22+
Basic features like file listing are free, but **direct link functionalities (e.g., preview, download) require paid open platform access**.
23+
24+
Please visit [123YunPan](https://www.123pan.com/) to purchase the "VIP" service and go to the [123 Open Platform](https://www.123pan.com/developer) to create an application and obtain your credentials (Client ID and Client Key).
25+
:::
26+
27+
::::: tabs#123 Open
28+
29+
@tab Integration Guide
30+
31+
## Integration Guide
32+
33+
To mount 123YunPan resources to Alist using `123 Open`, complete the following steps:
34+
35+
### Prerequisites
36+
37+
- You have a registered and logged-in 123YunPan account
38+
- You have created an application at the [123YunPan Open Platform](https://www.123pan.com/developer) and obtained:
39+
- **Client ID**
40+
- **Client Key**
41+
- (Optional) You have subscribed to the "VIP" service to enable advanced features such as direct links
42+
43+
::: warning Notes
44+
During the mounting process, Alist will use the `Client ID` and `Client Key` to automatically obtain and maintain an access token in the background, without user intervention.
45+
46+
This process happens locally, with no third-party relay, so there is **no risk of privacy leakage**.
47+
However, please keep your `Client ID` and `Client Key` safe to avoid exposure.
48+
:::
49+
50+
---
51+
52+
@tab Direct Link Settings
53+
54+
## Configure Direct Link Space (for Preview/Download)
55+
56+
::: danger Required Setting
57+
If Direct Link Space is not enabled, Alist cannot generate preview or download links.
58+
:::
59+
60+
### 1. Enable Direct Link Space
61+
62+
Visit [123YunPan](https://www.123pan.com/) and follow these steps:
63+
64+
1. Locate the target folder and right-click it
65+
2. Click **Enable Direct Link Space**
66+
3. After enabling, the directory will show a direct link icon 🔗
67+
68+
![Direct Link Space](/img/drivers/123/open/123_link.png)
69+
70+
### 2. Get Folder ID
71+
72+
1. Enter the folder
73+
2. The Folder ID is the last part of the URL in your browser's address bar
74+
3. Use this ID in Alist as the mount directory
75+
76+
---
77+
78+
@tab Feature Support
79+
80+
## Feature Support Details
81+
82+
The following features are currently supported by the `123 Open` driver:
83+
84+
### ✅ Supported Features
85+
86+
- 📁 **Browse files/folders**
87+
- 📥 **Download / Preview** (requires direct link enabled)
88+
- 📤 **Upload files** (supports instant and chunked upload)
89+
- 🗂️ **Create folders**
90+
- ✏️ **Rename**
91+
- 🗃️ **Move files/folders**
92+
- 🗑️ **Delete**
93+
- 🔐 **Automatic token acquisition and refresh**
94+
95+
::: tip Upload Note
96+
If the uploaded file does not include a complete hash, Alist will cache the file and calculate the MD5 automatically.
97+
:::
98+
99+
### ⚠️ Unsupported Features
100+
101+
::: warning The following features are not currently supported:
102+
103+
- ❌ Copy files/folders
104+
- ❌ Online compression/decompression
105+
- ❌ Archive (batch) download
106+
:::
107+
108+
::: danger Root Directory Limitation
109+
Although the root directory (ID = 0) can be mounted, **direct link features such as preview, video playback, or image viewing are not available in the root directory**.
110+
111+
It is recommended to mount a **subfolder with Direct Link Space enabled**.
112+
:::
113+
114+
---
115+
116+
:::::
117+
118+
## Default Download Method
119+
120+
```mermaid
121+
---
122+
title: Default Download Method
123+
---
124+
flowchart TB
125+
style a1 fill:#bbf,stroke:#f66,stroke-width:2px,color:#fff
126+
style a2 fill:#ff7575,stroke:#333,stroke-width:4px
127+
subgraph ide1 [ ]
128+
a1
129+
end
130+
a1[302]:::someclass====|Default|a2[User Device]
131+
classDef someclass fill:#f96
132+
c1[Local Proxy]-.Alternative.->a2[User Device]
133+
b1[Proxy URL]-.Alternative.->a2[User Device]
134+
click a1 "../drivers/common.html#webdav-strategy"
135+
click b1 "../drivers/common.html#webdav-strategy"
136+
click c1 "../drivers/common.html#webdav-strategy"

‎docs/zh/guide/drivers/123_open.md‎

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
---
2+
icon: iconfont icon-api
3+
order: 62
4+
category:
5+
- Guide
6+
tag:
7+
- Storage
8+
- Guide
9+
- 123 Open
10+
sticky: true
11+
star: true
12+
author: 千石(okatu-loli)
13+
---
14+
15+
# 123 Open（开放平台）
16+
17+
`123 Open` 是 123云盘推出的开放平台接口，可通过密钥鉴权的方式在 Alist 中实现挂载访问。
18+
19+
支持文件浏览、上传、预览、下载、管理等功能，并由 Alist 自动维护 token 生命周期。
20+
21+
::: warning 需开通付费功能
22+
文件列表等基础功能可免费使用，但**直链相关功能（如预览、下载）依赖于付费的开放平台权限**。
23+
24+
请前往 [123云盘](https://www.123pan.com/) 购买「VIP」服务，并在 [123开放平台](https://www.123pan.com/developer) 创建应用以获取接口凭证（Client ID 和 Client Key）。
25+
:::
26+
27+
::::: tabs#123 Open
28+
29+
@tab 接入说明
30+
31+
## 接入说明
32+
33+
要通过 `123 Open` 将 123云盘资源挂载到 Alist，请先完成以下准备工作：
34+
35+
### 开通条件
36+
37+
- 已注册并登录 123云盘账户
38+
- 已在 [123云盘开放平台](https://www.123pan.com/developer) 创建应用，获取：
39+
- **Client ID**
40+
- **Client Key**
41+
- （可选）开通「VIP」服务，以启用直链等高级功能
42+
43+
::: warning 注意事项
44+
挂载过程中，Alist 将使用 `Client ID` 和 `Client Key` 自动获取访问凭证（Token），并在后台自动维护，无需用户干预。
45+
46+
该过程仅在本地进行，不涉及任何外部中转，因此**不存在隐私泄露风险**。
47+
但请务必妥善保管你的 `Client ID` 和 `Client Key`，避免泄露。
48+
:::
49+
50+
---
51+
52+
@tab 直链设置
53+
54+
## 设置直链空间（用于预览/下载）
55+
56+
::: danger 请务必完成以下设置
57+
未启用「直链空间」将导致 Alist 无法生成直链或预览链接。
58+
:::
59+
60+
### 1. 开启直链空间
61+
62+
进入 [123云盘](https://www.123pan.com/)，按以下步骤操作：
63+
64+
1. 找到目标文件夹，点击右键
65+
2. 点击 **启用直链空间**
66+
3. 启用后该目录会显示直链图标 🔗
67+
68+
![直链空间](/img/drivers/123/open/123_link.png)
69+
70+
### 2. 获取 Folder ID
71+
72+
1. 进入该文件夹
73+
2. 浏览器地址栏中，URL 的末尾即为 Folder ID
74+
3. 在 Alist 中填写此 ID 作为挂载目录
75+
76+
---
77+
78+
@tab 功能支持
79+
80+
## 功能支持说明
81+
82+
以下为 `123 Open` 驱动当前支持的功能：
83+
84+
### ✅ 支持功能
85+
86+
- 📁 **浏览文件/文件夹**
87+
- 📥 **下载 / 预览（需开启直链）**
88+
- 📤 **上传文件（支持秒传、分片）**
89+
- 🗂️ **新建文件夹**
90+
- ✏️ **重命名**
91+
- 🗃️ **移动文件/文件夹**
92+
- 🗑️ **删除**
93+
- 🔐 **token 自动获取与刷新**
94+
95+
::: tip 上传说明
96+
如上传的文件未提供完整哈希，Alist 会自动缓存后计算 MD5 值。
97+
:::
98+
99+
### ⚠️ 不支持功能
100+
101+
::: warning 当前暂不支持以下功能：
102+
103+
- ❌ 文件/文件夹复制
104+
- ❌ 在线压缩、解压
105+
- ❌ 打包下载
106+
:::
107+
108+
::: danger 根目录限制
109+
110+
虽然可以将根目录（ID 为 0）作为挂载目录，但**无法在根目录使用直链功能**（如预览、视频播放、图片查看等）。
111+
112+
建议将挂载目录设置为已**开启直链空间的子文件夹**。
113+
:::
114+
115+
---
116+
117+
:::::
118+
119+
## 默认使用的下载方式
120+
121+
```mermaid
122+
---
123+
title: 默认使用的下载方式
124+
---
125+
flowchart TB
126+
style a1 fill:#bbf,stroke:#f66,stroke-width:2px,color:#fff
127+
style a2 fill:#ff7575,stroke:#333,stroke-width:4px
128+
subgraph ide1 [ ]
129+
a1
130+
end
131+
a1[302]:::someclass====|默认|a2[用户设备]
132+
classDef someclass fill:#f96
133+
c1[本机代理]-.备选.->a2[用户设备]
134+
b1[代理URL]-.备选.->a2[用户设备]
135+
click a1 "../drivers/common.html#webdav-策略"
136+
click b1 "../drivers/common.html#webdav-策略"
137+
click c1 "../drivers/common.html#webdav-策略"

0 commit comments

Comments
 (0)