OpenList APIPages

OpenListTeam/OpenList-APIPages is a utility website led by @PIKACHUIM and collaboratively developed with other main contributors. The frontend is primarily used for initial authorization and obtaining refresh tokens of cloud storage clients, while the backend mainly supports a feature called "Online API", which enables remote token refresh functionality while protecting developer client secrets.

OpenListTeam/OpenList-APIPages 是一个由 @PIKACHUIM 牵头，和其他主要贡献者共同协作完成的工具型网站，前端主要用于实现对网盘客户端的初始授权和刷新令牌，而后端则主要支撑了一个名为“在线API”的功能，可以在保护开发者客户端密钥的前提下，实现对用户令牌的远程刷新功能。

Cloud Storage Background:

• Most domestic cloud storage services do not provide official API access to individuals, or the application process is cumbersome, which is not conducive to rapid deployment.
• According to the cloud storage providers’ management requirements, the obtained client keys must not be leaked.
• User authorization is in the form of refresh tokens, which need to be periodically combined with client keys to obtain refreshed access tokens from the cloud storage servers.
• API calls require the user’s latest access tokens.

Solution:

• Community volunteers provide qualification certification and apply for API access permissions from cloud storage officials.
• Use relay servers to protect client keys.
• Periodically send refresh tokens to designated relay servers, which use built-in client keys to refresh access tokens.
• The relay server sends access tokens back to the OpenList client.

The relay server described above is the backend functionality of the Online API server/APIPages, which works as follows:

The frontend part of APIPages also solves the following problems:

• Initial authorization verification for different cloud storage services.
• Authorization while protecting built-in client keys.
• Authorization with custom client keys.
• Providing callback addresses for custom client keys.
• Other practical functions for cloud storage mounting.

网盘背景：

• 大部分国内网盘没有对个人开放官方API调用的权限，或者申请过程繁琐，不利于快速部署。
• 针对申请下来的客户端密钥，根据网盘方的管理要求，不得外泄。
• 用户授权为刷新令牌，需要定期配合客户端密钥向网盘服务器获取刷新后的访问令牌。
• 调用API需要用户最新的访问令牌。

解决方案：

• 由社区中的志愿者提供资质认证，向网盘官方申请API调用权限。
• 利用中转服务器，保护客户端密钥。
• 定期向指定的中转服务器发送刷新令牌，中转服务器利用内置的客户端密钥，刷新访问令牌
• 中转服务器将访问令牌发送回OpenList客户端。 上述描述的中转服务器，就是在线API服务器/Online API 服务器/APIPages的后端部分功能，其工作原理如下：

APIPages的前端部分同时解决了如下问题：

• 不同网盘的初始授权验证。
• 在保护内置客户端密钥的情况下的授权。
• 自定义客户端密钥下的授权。
• 提供自定义客户端密钥下的的回调地址。
• 其他网盘挂载的实用功能。

If you choose not to use community-provided servers or deploy your own server, please verify the following content:

• 1. Have completely read the documentation related to the corresponding cloud storage driver.
• 2. Have completely read the open API development documentation provided by the corresponding cloud storage service.
• 3. Can read and understand the project code, have certain debugging capabilities, and can understand the corresponding logs and error messages.
• 4. Fully understand the rights granted to you by AGPLv3 and the parts we should be responsible for.
• 5. Can use basic GitHub functions and know how to correctly submit issues/pull requests to us.
• 6. Please remember that we have no way to solve your network problems.

如果您选择不使用社区提供的服务器，或者自己部署服务器，请对照一下内容进行核实

• 1.完整阅读了对应网盘驱动相关内容的文档。
• 2.完整阅读了对应网盘的提供的开放API开发文档。
• 3.可以阅读并理解项目代码，并有一定的debug能力，能看懂对应的日志及其报错。
• 4.完全理解AGPLv3授予您的权力和我们应该负责的部分。
• 5.可以使用GitHub的基本功能，知道如何正确的向我们提交Issue/Pull Request。
• 6.请记住，我们没有任何办法可以解决您遇到的网络问题。

• EdgeOne Functions International

After deployment, please log in to the EdgeOne Functions console to modify environment variables. Please refer to the Variable Description section.

• EdgeOne Functions China

After deployment, please log in to the EdgeOne Functions console to modify environment variables. Please refer to the Variable Description section.

• Cloudflare Workers Global

After deployment, please log in to the Cloudflare Workers console to modify environment variables. Please refer to the Variable Description section.

• EdgeOne Functions 国际站

部署完成后，请登录EdgeOne Functions后台，修改环境变量，请参考变量说明部分

• EdgeOne Functions 中国站

部署完成后，请登录EdgeOne Functions后台，修改环境变量，请参考变量说明部分

• Cloudflare Worker 全球站

部署完成后，请登录Cloudflare Worker后台，修改环境变量，请参考变量说明部分

• Pull image

docker pull openlistteam/openlist_api_server

or

docker pull ghcr.io/openlistteam/openlist_api_server:latest

• Start project

docker run -d --name oplist-api-server \
  -p 3000:3000 \
  -e OPLIST_MAIN_URLS="api.example.com" \
  -e OPLIST_PROXY_API="gts.example.com" \
  -e OPLIST_ONEDRIVE_UID= `#optional` \
  -e OPLIST_ONEDRIVE_KEY= `#optional` \
  -e OPLIST_ALICLOUD_UID= `#optional` \
  -e OPLIST_ALICLOUD_KEY= `#optional` \
  -e OPLIST_BAIDUYUN_UID= `#optional` \
  -e OPLIST_BAIDUYUN_KEY= `#optional` \
  -e OPLIST_BAIDUYUN_EXT= `#optional` \
  -e OPLIST_CLOUD115_UID= `#optional` \
  -e OPLIST_CLOUD115_KEY= `#optional` \
  -e OPLIST_GOOGLEUI_UID= `#optional` \
  -e OPLIST_GOOGLEUI_KEY= `#optional` \
  -e OPLIST_YANDEXUI_UID= `#optional` \
  -e OPLIST_YANDEXUI_KEY= `#optional` \
  -e OPLIST_DROPBOXS_UID= `#optional` \
  -e OPLIST_DROPBOXS_KEY= `#optional` \
  -e OPLIST_QUARKPAN_UID= `#optional` \
  -e OPLIST_QUARKPAN_KEY= `#optional` \
  openlistteam/openlist_api_server:latest

• You can replace the image with ghcr:

  ghcr.io/openlistteam/openlist_api_server:latest

• Please make sure to modify your environment variables according to the environment variables below

• Environment Variable Description

• 拉取镜像

docker pull openlistteam/openlist_api_server

或者

docker pull ghcr.io/openlistteam/openlist_api_server:latest

• 启动项目

docker run -d --name oplist-api-server \
  -p 3000:3000 \
  -e OPLIST_MAIN_URLS="api.example.com" \
  -e OPLIST_PROXY_API="gts.example.com" \
  -e OPLIST_ONEDRIVE_UID= `#optional` \
  -e OPLIST_ONEDRIVE_KEY= `#optional` \
  -e OPLIST_ALICLOUD_UID= `#optional` \
  -e OPLIST_ALICLOUD_KEY= `#optional` \
  -e OPLIST_BAIDUYUN_UID= `#optional` \
  -e OPLIST_BAIDUYUN_KEY= `#optional` \
  -e OPLIST_BAIDUYUN_EXT= `#optional` \
  -e OPLIST_CLOUD115_UID= `#optional` \
  -e OPLIST_CLOUD115_KEY= `#optional` \
  -e OPLIST_GOOGLEUI_UID= `#optional` \
  -e OPLIST_GOOGLEUI_KEY= `#optional` \
  -e OPLIST_YANDEXUI_UID= `#optional` \
  -e OPLIST_YANDEXUI_KEY= `#optional` \
  -e OPLIST_DROPBOXS_UID= `#optional` \
  -e OPLIST_DROPBOXS_KEY= `#optional` \
  -e OPLIST_QUARKPAN_UID= `#optional` \
  -e OPLIST_QUARKPAN_KEY= `#optional` \
  openlistteam/openlist_api_server:latest

• 可以替换镜像为ghcr:

  ghcr.io/openlistteam/openlist_api_server:latest

• 请务必根据下面的环境变量，修改你使用的环境变量

• 环境变量说明

• Clone code

git clone https://github.com/OpenListTeam/OpenList-APIPages.git

• Modify configuration (CloudFlare only)

Create and modify wrangler.jsonc

cp wrangler.example.jsonc wrangler.encrypt.jsonc

Modify variable information:

• MAIN_URLS: Domain name for deployment callback address
• Other parameters: Application information for each cloud storage service

  "vars": {
    "MAIN_URLS": "api.example.com",
    "PROXY_API": "gts.example.com",
    "onedrive_uid": "*****************************",
    "onedrive_key": "*****************************",
    "alicloud_uid": "*****************************",
    "alicloud_key": "*****************************",
    "baiduyun_uid": "*****************************",
    "baiduyun_key": "*****************************",
    "baiduyun_ext": "*****************************",
    "cloud115_uid": "*****************************",
    "cloud115_key": "*****************************",
    "googleui_uid": "*****************************",
    "googleui_key": "*****************************",
    "yandexui_uid": "*****************************",
    "yandexui_key": "*****************************",
    "dropboxs_uid": "*****************************",
    "dropboxs_key": "*****************************",
    "quarkpan_uid": "*****************************",
    "quarkpan_key": "*****************************"
  },

• Test code

npm install

# Run in Cloudflare Worker environment
npm run dev-cf

# Run in Edgeone Functions environment
npm run dev-eo

# Run in Node Service Work environment
npm run dev-js

• Deploy project

# Deploy in Cloudflare Worker environment
npm run deploy-cf

# Deploy in Edgeone Functions environment
npm run deploy-eo

# Run locally in Node Service Work
npm build-js && npm deploy-js

• 克隆代码

git clone https://github.com/OpenListTeam/OpenList-APIPages.git

• 修改配置 (CloudFlare才需要)

创建并修改wrangler.jsonc

cp wrangler.example.jsonc wrangler.encrypt.jsonc

修改变量信息：

• MAIN_URLS：部署回调地址的域名
• 其他参数?：各个网盘的应用信息

  "vars": {
    "MAIN_URLS": "api.example.com",
    "PROXY_API": "gts.example.com",
    "onedrive_uid": "*****************************",
    "onedrive_key": "*****************************",
    "alicloud_uid": "*****************************",
    "alicloud_key": "*****************************",
    "baiduyun_uid": "*****************************",
    "baiduyun_key": "*****************************",
    "baiduyun_ext": "*****************************",
    "cloud115_uid": "*****************************",
    "cloud115_key": "*****************************",
    "googleui_uid": "*****************************",
    "googleui_key": "*****************************",
    "yandexui_uid": "*****************************",
    "yandexui_key": "*****************************",
    "dropboxs_uid": "*****************************",
    "dropboxs_key": "*****************************",
    "quarkpan_uid": "*****************************",
    "quarkpan_key": "*****************************"
  },

• 测试代码

npm install

# 以Cloudflare Worker环境运行
npm run dev-cf

# 以Edgeone Functions环境运行
npm run dev-eo

# 以Node Service Work环境运行
npm run dev-js

• 部署项目

# 以Cloudflare Worker环境部署
npm run deploy-cf

# 以Edgeone Functions环境部署
npm run deploy-eo

# 以Node Service Work本地运行
npm build-js && npm deploy-js

Welcome to submit more community servers

欢迎提交更多社区服务器