夸克自动转存API接口使用手册：构建第三方集成的完整参考

夸克自动转存API接口使用手册：构建第三方集成的完整参考

【免费下载链接】quark_auto_save夸克网盘签到、自动转存、命名整理、发推送提醒和刷新媒体库一条龙项目地址: https://gitcode.com/gh_mirrors/qu/quark_auto_save

夸克自动转存API接口是夸克网盘签到、自动转存、命名整理、发推送提醒和刷新媒体库一条龙服务的核心组件，为开发者提供了强大的工具来构建第三方集成应用。通过这些接口，您可以轻松实现与夸克网盘的各种交互操作，极大地扩展了夸克网盘的功能和使用场景。

接口概览与核心功能

夸克自动转存API接口涵盖了从资源搜索到任务管理的全方位功能，为开发者提供了便捷、高效的集成能力。无论是获取系统配置、搜索资源，还是添加任务、执行转存操作，都可以通过简洁的API调用来实现。

主要接口分类

夸克自动转存API接口主要分为以下几类：

1. 系统信息接口：用于获取系统配置和任务列表等信息。
2. 资源搜索接口：提供强大的资源搜索功能，帮助用户快速找到所需内容。
3. 任务管理接口：包括任务的添加、执行、查询等操作。
4. 文件操作接口：用于文件的转存、删除、路径查询等。

接口调用流程

接口调用的基本流程如下：

1. 设置环境变量QAS_BASE_URL和QAS_TOKEN，分别指定API的基础URL和访问令牌。
2. 根据具体需求选择合适的API接口和请求方法（GET或POST）。
3. 构建请求参数，确保参数的完整性和正确性。
4. 发送API请求，并处理返回结果。

环境准备与基础配置

在开始使用夸克自动转存API接口之前，需要进行必要的环境准备和基础配置，以确保接口调用的顺利进行。

环境变量设置

夸克自动转存API接口通过环境变量来获取必要的配置信息，主要包括以下两个环境变量：

• QAS_BASE_URL：API的基础URL地址。
• QAS_TOKEN：访问API所需的令牌。

您可以通过以下方式设置环境变量：

export QAS_BASE_URL="http://your-api-base-url" export QAS_TOKEN="your-api-token"

API客户端工具

为了方便开发者使用夸克自动转存API接口，项目提供了一个Python客户端工具qas_client.py，位于skills/quark-auto-save/scripts/qas_client.py。该工具封装了API的调用方法，提供了简洁的命令行接口，可用于快速测试和使用各种API功能。

核心API接口详解

系统信息接口

获取系统配置和任务列表

接口端点：/data

请求方法：GET

参数说明：无额外参数，令牌通过查询参数传递。

返回结果：包含系统配置和任务列表的JSON数据。

使用示例：

import qas_client result = qas_client.get("/data") if result.get("success"): data = result["data"] print("系统配置：", data.get("config")) print("任务列表：", data.get("tasklist"))

通过该接口，您可以获取当前系统的配置信息，如API令牌、定时任务设置等，以及所有已创建的任务列表。

资源搜索接口

搜索资源

接口端点：/task_suggestions

请求方法：GET

参数说明：

• q：搜索关键词。
• d：是否深度搜索，1表示深度搜索，0表示普通搜索。

返回结果：包含搜索结果的JSON数据，每个结果包含资源标题、分享链接、时间等信息。

使用示例：

import qas_client result = qas_client.get("/task_suggestions", {"q": "电影", "d": "1"}) if result.get("success"): data = result.get("data", []) for item in data: print("标题：", item.get("title")) print("分享链接：", item.get("shareurl"))

该接口提供了强大的资源搜索功能，您可以根据关键词搜索各种资源，并获取详细的资源信息。

任务管理接口

添加任务

接口端点：/api/add_task

请求方法：POST

参数说明：任务的详细信息，包括任务名称、分享链接、保存路径、正则匹配规则等。

返回结果：包含任务添加结果的JSON数据。

使用示例：

import qas_client import json task = { "taskname": "测试任务", "shareurl": "https://pan.quark.cn/s/xxxxxx", "savepath": "/test", "pattern": "TV", "replace": "电视剧" } result = qas_client.post("/api/add_task", task) if result.get("success"): print("任务添加成功")

通过该接口，您可以创建新的自动转存任务，设置任务的各种参数，如分享链接、保存路径、文件命名规则等。

执行任务

接口端点：/run_script_now

请求方法：POST

参数说明：可选的任务列表，若不指定则执行所有任务。

返回结果：包含任务执行日志的原始文本数据。

使用示例：

import qas_client # 执行所有任务 result = qas_client.post("/run_script_now", raw=True) if result.get("success"): print(result.get("raw"))

该接口用于手动触发任务的执行，您可以选择执行特定的任务或所有任务，并获取详细的执行日志。

文件操作接口

获取分享链接详情

接口端点：/get_share_detail

请求方法：POST

参数说明：

• shareurl：分享链接。

返回结果：包含分享资源详细信息的JSON数据，如文件名称、类型、大小、文件列表等。

使用示例：

import qas_client result = qas_client.post("/get_share_detail", {"shareurl": "https://pan.quark.cn/s/xxxxxx"}) if result.get("success"): data = result["data"] print("文件名称：", data.get("file_name")) print("文件类型：", "文件夹" if data.get("dir") else "文件") print("文件列表：", data.get("list"))

通过该接口，您可以获取指定分享链接的详细信息，包括其中包含的文件列表等。

检查保存路径

接口端点：/get_savepath_detail

请求方法：GET

参数说明：

• path：保存路径。

返回结果：包含保存路径详细信息的JSON数据，如路径结构、文件列表等。

使用示例：

import qas_client result = qas_client.get("/get_savepath_detail", {"path": "/test"}) if result.get("success"): data = result["data"] print("路径：", data.get("path")) print("文件列表：", data.get("list"))

该接口用于检查指定的保存路径是否存在，以及获取该路径下的文件列表等信息。

任务配置与高级应用

任务参数详解

在添加任务时，需要设置各种参数来控制任务的行为。以下是一些常用的任务参数：

• taskname：任务名称，用于标识任务。
• shareurl：夸克网盘分享链接，指定要转存的资源。
• savepath：保存路径，指定资源在夸克网盘中的保存位置。
• pattern和replace：正则匹配和替换规则，用于对文件名进行重命名。
• enabled：任务是否启用，True表示启用，False表示禁用。

正则匹配与文件命名

夸克自动转存API接口支持使用正则表达式对文件名进行匹配和重命名，这为文件的整理和管理提供了强大的灵活性。例如，您可以使用正则表达式将文件名中的特定字符串替换为其他内容，或者提取文件名中的关键信息作为新的文件名。

媒体库刷新集成

夸克自动转存API接口还可以与媒体库（如Emby、Plex等）集成，实现媒体库的自动刷新。通过相关插件（如plugins/emby.py、plugins/plex.py），可以在资源转存完成后自动刷新媒体库，确保新添加的媒体文件能够及时被媒体服务器识别和索引。

错误处理与调试技巧

在使用夸克自动转存API接口的过程中，可能会遇到各种错误。以下是一些常见的错误处理和调试技巧：

常见错误及解决方法

1. 认证失败：检查QAS_TOKEN是否正确设置，确保令牌的有效性。
2. 参数错误：仔细检查API请求的参数是否完整、格式是否正确。
3. 网络错误：检查网络连接是否正常，确保API的基础URL可访问。
4. 任务执行失败：查看任务执行日志，分析失败原因，可能是分享链接无效、保存路径不存在等。

调试工具与方法

1. 日志查看：通过API接口获取任务执行日志，详细了解任务的执行过程和错误信息。
2. 命令行测试：使用提供的qas_client.py工具进行命令行测试，快速验证API接口的功能。
3. 接口文档参考：参考API接口的文档和示例代码，确保接口调用的正确性。

总结与最佳实践

夸克自动转存API接口为开发者提供了强大而灵活的工具，用于构建与夸克网盘的第三方集成应用。通过本文档的介绍，您应该已经了解了API接口的基本使用方法和核心功能。

最佳实践建议

1. 合理使用环境变量：确保QAS_BASE_URL和QAS_TOKEN的正确设置，避免在代码中硬编码敏感信息。
2. 详细记录任务日志：在集成应用中，详细记录任务的执行日志，便于问题排查和系统维护。
3. 定期更新API客户端：及时更新qas_client.py工具，以获取最新的功能和 bug 修复。
4. 遵循API调用频率限制：避免过于频繁地调用API接口，以免对服务器造成过大压力。

通过遵循这些最佳实践，您可以更加高效、稳定地使用夸克自动转存API接口，构建出功能强大、用户体验良好的第三方集成应用。

要开始使用夸克自动转存API接口，您可以先克隆项目仓库：

git clone https://gitcode.com/gh_mirrors/qu/quark_auto_save

然后按照本文档的指导进行环境配置和接口调用，探索夸克自动转存API接口的更多功能和应用场景。

【免费下载链接】quark_auto_save夸克网盘签到、自动转存、命名整理、发推送提醒和刷新媒体库一条龙项目地址: https://gitcode.com/gh_mirrors/qu/quark_auto_save