使用 Aspose.Cells Cloud API 将 Excel 转换为 JSON — 快速指南
Contents
[
Hide
]
REST API
此 REST API 将电子表格文件转换为 JSON 格式的文件。
POST https://api.aspose.cloud/v3.0/cells/convert/json
安全与身份验证
Aspose.Cells Cloud API 采用安全机制,需使用 基于 JWT 令牌的身份验证。
请求
查询参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
password |
string | 打开 Excel 文件所需的密码(可选)。 |
storageName |
string | 文件所在存储空间的名称(可选)。 |
checkExcelRestriction |
bool | 修改单元格时是否强制应用 Excel 特定限制(可选)。 |
请求体参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
datafile |
file | 待上传的 Excel 文件。必须作为 multipart/form-data 请求的第一部分发送。 |
示例 cURL 调用
curl -X POST "https://api.aspose.cloud/v3.0/cells/convert/json" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "accept: application/json" \
-H "Content-Type: multipart/form-data" \
-F "File=@myWorkbook.xlsx"
响应
服务返回一个 FileInfo 对象。关键字段说明如下:
| 字段 | 类型 | 描述 |
|---|---|---|
Filename |
string | 生成的 JSON 文件名(例如 myWorkbook.json)。 |
FileSize |
integer | 生成文件的大小(单位:字节)。 |
FileContent |
string | JSON 文件内容的 Base64 编码字符串。解码后可获取实际 JSON 内容。 |
响应示例
{
"Filename": "myWorkbook.json",
"FileSize": 8423,
"FileContent": "eyJmb3JtYXR0ZWRfZGF0YSI6IH ... (base64 字符串) ..."
}
错误处理
若请求失败,API 将返回包含以下结构的错误对象:
| 字段 | 类型 | 描述 |
|---|---|---|
Code |
string | 机器可读的错误标识符。 |
Message |
string | 人类可读的错误描述。 |
常见 HTTP 状态码:
- 400 – 请求错误(例如,缺少文件、参数无效)。
- 401 – 未授权(访问令牌无效或缺失)。
- 500 – 服务器内部错误。
HTTP 状态码
| 状态码 | 含义 | 描述 |
|---|---|---|
| 200 | OK(成功) | 过滤器应用成功;响应包含操作详情。 |
| 400 | Bad Request(请求错误) | 参数缺失或无效(例如,不支持的文件类型)。 |
| 401 | Unauthorized(未授权) | JWT 令牌无效或缺失。 |
| 413 | Payload Too Large(载荷过大) | 上传文件超出大小限制。 |
| 500 | Internal Server Error(服务器内部错误) | 服务器发生意外错误。 |
如何使用 PostConvertWorkbookToJson API(配合 SDK)
PostConvertWorkbookToJson API 规范
OpenAPI 规范 定义了一个公开可访问的编程接口,让您能直接从 Web 浏览器发起 REST 请求。
您可使用 cURL 命令行工具轻松访问 Aspose.Cells Web 服务。以下示例展示了如何使用 cURL 调用云 API。
使用 Aspose.Cells Cloud SDK
使用 SDK 是加速开发的最佳方式。SDK 会处理底层细节,使您能专注于项目核心任务。请查看 GitHub 仓库 以获取完整的 Aspose.Cells Cloud SDK 列表。
以下代码示例展示了如何使用不同 SDK 调用 Aspose.Cells Web 服务:
实现类似功能的其他 API
- POST /cells/{name}/saveAs – 将 Excel 文件保存为 HTML 文件(支持额外设置),并将结果存储于指定存储空间中。
- PUT /cells/convert – 将 Excel 文件转换为 HTML 文件(支持额外设置),并将结果直接返回于响应中。
- GET /cells/{name} – 获取 Excel 文件;可通过查询参数指定返回 HTML 格式。