> For the complete documentation index, see [llms.txt](https://docs.docbits.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.docbits.com/chinese/gao-ji-gong-neng-yu-gong-ju/postman-for-docbits.md).

# DocBits 的 Postman 使用指南

本指南将介绍如何通过 Postman 向您的 DocBits 组织发送 HTTP 请求。Postman 易于使用，对组织管理员也非常实用。

## 设置

首先，将 Postman 下载到您的系统中，然后登录或注册。

现在，按照以下分步指南了解如何在 Postman 中发送 HTTP 请求。

Postman 中的授权

在创建 HTTP 请求之前，您需要输入 DocBits 的 API 密钥进行授权。

* 点击 `Authorization` 选项卡，并选择 `API Key` 作为授权类型。

![](https://lh7-us.googleusercontent.com/L3GaBZJvReeINaKbkq3VYQ9UHTBoKUA3nJkfyLqk61q5xaOJnmMLhbrEbgUgLEyYRkewHuLIAVzoYCZ6quHq0pwx_69FEYJjzYllivB8WzdAtTFSrzl8VeFthbMsEB9sGjcGlVN38DXEXUwuNEPL6hg)

* 填写相应的值。在 `Key` 字段中输入“X-API-key”，并将您的 API 密钥作为值输入（可在 DocBits 的“设置”菜单中的“集成”下找到）。选择将其添加到 `Header`。
* 界面应如下所示：

![](https://lh7-us.googleusercontent.com/SmNfci4z8ECTeXzFPE9YQ8nCzCRHglc_7RR1cN8a8F7KvYWjJcBnY5wpl7q0AV8bfNLkMk8F4F4aw8j4xMK50HJweBRBPo8EasTn-FG-fmlUJQ41aUX-dvTeWP_xJQThi8A6EwJl3qIc-Dw1B5W9fVE)

### DocBits API

可通过 <https://api.polydocs.io> 访问

* 点击右上角的 Authorize

![](https://lh7-us.googleusercontent.com/kuztHpkmRWlOYSU27r97KH15SJHPF_hn_eX3C1DYLVYCwMHXfLjYSyFubUCvlQiBt5q3xY0XBPmkcP6AnKF2C0Mdtx3tg_dU_qxqAmI6axYIsXR36_YBz6j455K3-c2SBu4YzmYIXq8VXQxzgL-0j90)

* 输入您的 API 密钥，然后点击 `Authorize` 确认

![](https://lh7-us.googleusercontent.com/zLhgpdjMnxqNBdjgtDxFEKglICIZul7dgmfFFm2hSnsDQ-HsZHRKRikZ0lcanGYkkZj4waC85mEUFO951ydVnY__m_TrMrsK3vrDv9FKL-adgWL4lJqp3cSxPeClBm9IHG2cXinRsv12xTeh3psQfO4)

### 在 Postman 中创建新工作区

* 点击 Workspaces 并创建新工作区（名称可任意设置）

![](https://lh7-us.googleusercontent.com/3rZw7jhOgVpkZuer58fPEKqDspJjK3S1lp3XpQuvE4c9212a0ALB-p7oLRwPqEbj10MpoCWsb7V9fPqiAdVvigE00x9mN5-lHFXZVVxlkeroBJd2ratgkJVJDM4LJkUJsycyl6tnFKazcFPY-vWtH2Q)

* 您需要选择可见性，以确定哪些人可以访问此工作区。

![](https://lh7-us.googleusercontent.com/ZajvDtMvfM5J_Go3n_PgzD3RXTMQAlST8_3WnsTQ4-iw7e0QdAa3wqFk7Y0gt78IJVjNTN-5E72c1127CpXJWb8WbfDolxENLqxg5VZLPEK7-hxsNwbAyMceSHfeVy6v-b9QT0kFwnMibWndEAJ2lXA)

* 选择完成并点击 `Create Workspace` 后，在应用左侧选择 Collections，然后点击 `+` 为 HTTP 请求创建一个新集合。

![](https://lh7-us.googleusercontent.com/mbC5t86vaB2G7FQp-40XN-SHc019LKitfUeXRzbcG4HpNai5FPapShx9swHX3mz0va8QFsUQiYn-bhjvER0XYOEDRJpI9x3wG4NgRZCd4beU1NyKJd86bSGubxVbRCtz8HkTDZd28Z7Ice3rmscFMMo)

在此集合中，您可以添加多个 HTTP 请求。操作方法是点击集合旁边的三个点，然后选择 `Add request`。

![](https://lh7-us.googleusercontent.com/S5W75clJz7JqoIWPbKBjrJqpTAwjS51Pu4dTU160Q7i6oW-HPnb7aN8WRK2AyAb6-HEqTYMZTy9563P0sq53MAjGpVg1JivZX2ATHa6GeFbTX2UCjud7ot8Y_ksBuUbUfyEfxIDziV8TN3zDfX9Se58)

## “GET” 方法示例

GET 方法非常实用，可用于获取用户、子组织、已处理文档等信息。

* 在 HTTP 请求中选择 GET 方法。
* 按照上述说明进行授权。
* 打开 <https://api.polydocs.io，并在> Polydocs URL 后添加相应功能的路径。例如：

![](https://lh7-us.googleusercontent.com/pIdgyqP7g1UwZbY5yaz1KAnKe_ESs_kQyiWAXXM-ukRKakS__OL_LS9J-07hZnZDf8QqtoN_lKyuhvOIIIF-4Wp0dkofZYQwXZ0hu2RM0YogRxJah-zf8W_cDNFf8xsec1tYIsfe0SpBuvdCG4WHMU0)

* 现在，将此链接粘贴到 Postman 中 GET 方法旁边的文本框内。

点击 `Send`，您应该会收到组织中每位用户的所有信息。

## “POST” 方法示例

POST 方法通常用于创建用户或组织等对象。此方法会将信息写入数据库。

创建用户

* 选择 POST 方法。
* 按照上述说明进行授权
* 打开 <https://api.polydocs.io，并在> Polydocs URL 后添加相应功能的路径。本例中：

![](https://lh7-us.googleusercontent.com/Gwabl4pN0k0NanHsFOzJj9s2H7ExS-JcWr-Y4EW0FLUYHfnaOZoMWvldJ6yDI33p_DThVx0Rd5bi59XdOK11l1knc5rd-E5HXMw6v5E3qvHvKVWHlp21S728SVye6KU2W5ZeXtCIOzxBAcMlA2UNFfQ)

* 现在，将此链接粘贴到 Postman 中 POST 方法旁边的文本框内。
* 在 HTTP 请求中选择 `Body` 选项卡，并为名称旁带有红色星号的每项凭据输入键和值。

完成后，界面应如下所示：

![](https://lh7-us.googleusercontent.com/lSExzZSbTcSRvuLDw0HNYE62yI7xs0eUewKuOcABCGYfsRBRbGz1lJxopR4QdUEoniCnZ83FKpz-AHLORP5cXGPrPhgouzE6zO920jA7A3r-Y14wY_Gc3C98R2fcxXsWRMcle9qT981YWhCnjlUukPE)

如果要创建管理员账户，请将 `is_admin` 值设为 true。

最后，点击 `Send`，即可在下方的响应中查看您设置的所有凭据。这表示用户已创建。

### 上传文档

您也可以使用 POST 方法将文档上传到 DocBits。

* 选择 POST 方法。
* 按照上述说明进行授权。
* 打开 <https://api.polydocs.io，并在> Polydocs URL 后添加相应功能的路径。

本例中：

![](https://lh7-us.googleusercontent.com/-EwhMeH_WXYVmMKus1-IZKLZNyTcYktcf_YUT_m2nfStfKXuBxKBb1MZfUIQCN4ZxNKQkNhvO_pgnt1EUhNB34qG5AOe4wM0OxGRMQsV9a8h0XUgabqq8mLQhza_AE7gxBetmb9bJmaWBQqEXrWT0VI)

* 现在，将此链接粘贴到 Postman 中 POST 方法旁边的文本框内。
* 在 HTTP 请求中选择 `Body` 选项卡，然后选择 `form-data`

![](https://lh7-us.googleusercontent.com/TNrKlyorn_5YrIu5r4vcfyYgAnfhsl-SRVqWg9RoN0X1pUjXtn6J0EI7aeQ-oc2ZtFeTj8POcMXy6CwXzI1jhv-ufb2u7d80SC-lbGXmnx_jVDunAbRw1jqAsB4PPsEzcFIOPeH5PJZvytUW2kIDYZ4)

![](https://lh7-us.googleusercontent.com/scAJpTSCqYSKYNNGPIrEsL0zDJIa7Dhe9tpqv_zDjdLyAydugzdGA1s93njbFOOVbVbQf7oDEtRc14Kt4p1TXX8A--WjvRgeXWsAxDNWdrCN2-QDeya6-FFEG4_-dhYgrj4yrVYllJs8eZsUgKOPvzo)

在 `KEY` 字段中输入 file，即可看到隐藏的 File 下拉菜单。选择 `File`，然后转到 `VALUE` 字段，点击 `Select Files` 选择文件。

点击 `Send` 后，您应该会在响应中看到 “success”: true。

界面应如下所示：

![](https://lh7-us.googleusercontent.com/hNtG_uTWgxww7iOmHLhnDqdrTlHCI1rk31LozG4l2DLPqxzSn9HoKn8CQIjeBgJLV4bxrGCjWOMRykJ3qBdZLYwxrZJGq_S3tjVwSZmGTiMgVoqM97TTQjmW8CegEL2FV309NBmV0Fv_vciSdQRFiOI)

## “DELETE” 方法示例

DELETE 方法用于删除用户、组织等对象。

* 选择 DELETE 方法
* 按照上述说明进行授权。
* 打开 <https://api.polydocs.io，并在> Polydocs URL 后添加相应功能的路径。

例如：

![](https://lh7-us.googleusercontent.com/-QqSVIELl1IkxYK_gGDa7nIv_B1IvO3OjT3Ge6bAXwPl6jVDETuzXwtYJdRSmqLEP2d6B0L6MuwZvgJpI968pzp1APmJmuQ_qlqYgZZhesocYCJVMCHhIZAKmlvMybUkUGXYZtySrnEbRTwWTritvKo)

* 现在，将此链接粘贴到 Postman 中 DELETE 方法旁边的文本框内。
* 将 URL 末尾的 {user\_id} 替换为要删除的实际用户 ID。（您可以使用 GET 方法获取 user\_id）。
* 如果已在 URL 中加入 user\_id，就不需要再为它添加正文键和值。
* 点击 `Send` 后，您应该会在响应中看到 “success”: true。

界面应如下所示：

![](https://lh7-us.googleusercontent.com/X8WNtsC9v7jqDIiaVhauJUgZK0yTC1GVz9rBptdiCxyLUiEEfbpIoYHpK7NvlDMTkhgiPyBb22H9GOfDdvmL-dakouTjuRDPwX4YX0Jz5IIo6eHu-wnw1S4jJd5ylHyffUXWKwX6ovDnp_2WEAtSha4)

## “PUT” 方法示例

PUT 方法主要用于更新用户或组织数据。它非常容易理解和使用。

* 选择 PUT 方法。
* 按照上述说明进行授权。
* 打开 <https://api.polydocs.io，并在> Polydocs URL 后添加相应功能的路径。

例如：

![](https://lh7-us.googleusercontent.com/tC3qtPbFb1GsK6dBmB5Jrv5HqFOYLxNR1XB0PEuA8ipkHnH2ZQ6xrrkImNgbGSMoA6aAGvLr6K3cI4u_qM96BOvR7AnQzmX17HBMBneNpLBc6RIzspfTYgrCWSj0fSE9mSWLIex3hc_R-m-PI6zT6Rs)

* 现在，将此链接粘贴到 Postman 中 PUT 方法旁边的文本框内。
* 将 URL 末尾的 {user\_id} 替换为要删除的实际用户 ID。（您可以使用 GET 方法获取 user\_id）。

## 更改用户的电子邮件地址

* 在正文中，将“email”作为键输入，并将新的电子邮件地址作为值输入。
* 然后点击 `Send`，您应该会在响应中看到 “success”。


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.docbits.com/chinese/gao-ji-gong-neng-yu-gong-ju/postman-for-docbits.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.