使用 Aspose.Cells Cloud API 保护 Excel 工作簿
Contents
[
Hide
]
此 REST API 保护 Excel 工作簿,使您能够使用 Aspose.Cells Cloud 安全地以密码和保护选项保护 Excel 工作簿。
PostProtectDocument API
POST https://api.aspose.cloud/v3.0/cells/{name}/protection
安全与身份验证
Aspose.Cells Cloud API 是安全的,需要基于 JWT 令牌的身份验证。
查询参数
| 参数名 | 类型 | 描述 |
|---|---|---|
| folder | string | 包含源工作簿的文件夹。(可选) |
| storageName | string | 存储位置的名称。(可选;默认值为 “Default”) |
请求体参数
| 参数名 | 类型 | 描述 |
|---|---|---|
| protection | WorkbookProtectionRequest | 定义工作簿保护设置的对象。 |
WorkbookProtectionRequest
| 参数名 | 类型 | 描述 |
|---|---|---|
| ProtectionType | string | 要应用的保护类型。允许的值(不区分大小写):ALL、CONTENTS、NONE、OBJECTS、SCENARIOS、STRUCTURE、WINDOWS。 |
| Password | string | 用于设置保护的可选密码。 |
响应
{
"Status":"OK",
"Code":200
}
HTTP 状态码
| 状态码 | 含义 | 描述 |
|---|---|---|
| 200 | OK(成功) | 过滤器应用成功;响应包含操作详情。 |
| 400 | Bad Request(错误请求) | 缺少或无效参数(例如不支持的文件类型)。 |
| 401 | Unauthorized(未授权) | JWT 令牌无效或缺失。 |
| 413 | Payload Too Large(请求实体过大) | 上传的文件超出大小限制。 |
| 500 | Internal Server Error(内部服务器错误) | 发生意外服务器错误。 |
如何使用 SDK 调用 PostProtectDocument API
前提条件
在调用 API 之前,请确保已完成以下步骤:
- 获取 JWT 访问令牌:按照“安全与身份验证”一节中描述的身份验证流程获取。
- 上传工作簿:将工作簿上传至您的 Aspose Cloud 存储空间,或确认其已存在于目标文件夹中。
- 明确存储名称(若未指定,默认为
"Default")及您希望保护的文件名。
PostProtectDocument API 规范
OpenAPI 规范 定义了一个公开可访问的编程接口,允许您直接从 Web 浏览器发起 REST 调用。
示例:使用 cURL 保护工作簿
-
按照前提条件 / 身份验证中的说明获取访问令牌。
-
执行请求:
curl -X POST "https://api.aspose.cloud/v3.0/cells/test.xlsx/protection?folder=MyFolder&storageName=MyStorage" \ -H "accept: application/json" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer <access_token>" \ -d '{ "ProtectionType": "ALL", "Password": "aspose" }'响应将包含一个状态对象,确认保护已成功应用。
使用 Aspose.Cells Cloud SDK
使用 SDK 是开发 Aspose.Cells Cloud 应用程序的最快方式。SDK 封装了底层细节,使您能够专注于业务逻辑。有关 Aspose.Cells Cloud SDK 的完整列表,请参阅 GitHub 仓库。
以下代码示例展示了如何使用各种 SDK 调用 Aspose.Cells Web 服务:
示例完整响应
{
"Status": "OK",
"Code": 200,
"Workbook": {
"Name": "test.xlsx",
"Path": "/MyFolder/test.xlsx",
"Protection": {
"ProtectionType": "ALL",
"Password": true
}
}
}