---
title: "通过 REST API 转换 ODT 文件"
description: "学习如何在 Tiptap 编辑器中处理 ODT 文件（OpenDocument 文本），包括编辑器内的导入/导出和 REST API 的使用。"
canonical_url: "https://tiptap.zhcndoc.com/conversion/legacy/odt/rest-api"
---

# 通过 REST API 转换 ODT 文件

学习如何在 Tiptap 编辑器中处理 ODT 文件（OpenDocument 文本），包括编辑器内的导入/导出和 REST API 的使用。

> **旧版 ODT REST API（已弃用）:**
>
> 该 REST API 已弃用，并将在 2026 年的某个时间点停止服务，届时团队会提前通知。对于新的集成，请使用更新后的 [ODT 导出 REST API](https://tiptap.zhcndoc.com/conversion/export/odt/rest-api.md) 和 [导入 REST API](https://tiptap.zhcndoc.com/conversion/import/docx/rest-api.md)。

- **1. 激活试用或订阅**

  在您的账户中开始一个[免费试用](https://cloud.tiptap.dev/v2?trial=true)或[订阅入门计划](https://cloud.tiptap.dev/v2/billing)。
- **2. 配置 Convert 应用**

  如果您想集成 REST API，请从[您的仪表盘](https://cloud.tiptap.dev/v2/cloud/convert)获取您的应用 ID 和 Convert 密钥。
- **3. 从私有注册表安装**

  要安装前端扩展，请按照[设置指南](https://tiptap.zhcndoc.com/guides/pro-extensions.md)在 Tiptap 的私有 npm 注册表中进行身份验证。

ODT 文档转换 API 支持从和转换到 Tiptap 的 JSON 格式。

> **查看 Postman 集合:**
>
> 您还可以通过访问我们的[Postman 集合](https://www.postman.com/tiptap-platform/workspace/tiptap-workspace/request/33042171-d272bdec-dba8-48d9-839e-04423fad6ef2)来体验文档转换 API。

## 导入 API 端点

`POST /import`

`/import` 端点使得将 `ODT` 文件转换为 Tiptap 的 JSON 格式成为可能。用户可以向此端点 POST 文档。

### 示例 (cURL)

```bash
curl -X POST "https://api.tiptap.dev/v1/convert/import" \
  -H "Authorization: Bearer <your-jwt>" \
  -H "X-App-Id: <your-app-id>" \
  -F "file=@/path/to/document.odt"
```

在此示例中，请求上传了一个 ODT 文件。

### 必需的请求头

| 名称              | 描述                                                                                                              |
| --------------- | --------------------------------------------------------------------------------------------------------------- |
| `Authorization` | 用于验证请求的 JWT 令牌。示例：`Bearer your-jwt-token`                                                                       |
| `X-App-Id`      | 来自协作设置页面的 Convert App-ID：[https://cloud.tiptap.dev/convert-settings](https://cloud.tiptap.dev/convert-settings) |

### 请求体

| 名称                       | 类型       | 描述                                               |
| ------------------------ | -------- | ------------------------------------------------ |
| `file`                   | `File`   | 要转换的文件                                           |
| `imageUploadCallbackUrl` | `string` | 用于上传在上传的文档中遇到的图像的回调端点，[查看更多信息](#image-uploading) |

## 导出 API 端点

`POST /export`

`/export` 端点将 Tiptap 文档转换回 `odt` 格式。

### 必需的请求头

| 名称              | 描述                                                                                                              |
| --------------- | --------------------------------------------------------------------------------------------------------------- |
| `Authorization` | 用于验证请求的 JWT 令牌。示例：`Bearer your-jwt-token`                                                                       |
| `X-App-Id`      | 来自协作设置页面的 Convert App-ID：[https://cloud.tiptap.dev/convert-settings](https://cloud.tiptap.dev/convert-settings) |

### 请求体

| 名称                | 类型       | 描述                      |
| ----------------- | -------- | ----------------------- |
| `prosemirrorJson` | `Object` | Tiptap/ProseMirror JSON |
| `to`              | `string` | 要转换的格式，应为 `odt`         |