> For the complete documentation index, see [llms.txt](https://docs.incogniton.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.incogniton.com/documentation/chinese-documentation/zi-dong-hua-api-he-sdk/local-rest-api.md).

# 使用本地 REST API

在设置 → 自动化中打开 Incogniton 的本地 REST API，选择其端口，并从您自己的计算机上的脚本控制您的配置文件。

在左侧菜单中打开**设置**并点击**自动化**选项卡。开启**启用自动化 API**并点击**保存**。然后，您的脚本可以通过 `http://127.0.0.1:35000` 访问 Incogniton。

本地 REST API 允许您计算机上的脚本和工具列出、创建、编辑、启动和停止您的浏览器配置文件。Incogniton CLI 以及 JavaScript 和 Python SDK 都使用此 API。

{% hint style="info" %}
自动化 API 是一项付费功能。在没有自动化的计划中，此选项卡上的设置是锁定的，并显示**您的计划中不包含自动化。以及一个升级**链接。
{% endhint %}

### 打开或关闭 API

{% stepper %}
{% step %}

#### 打开自动化选项卡

点击左侧菜单中的**设置**，然后点击**自动化**选项卡。
{% endstep %}

{% step %}

#### 打开 API

开启**启用自动化 API**。端口字段和 CLI 按钮只能在此开关打开时使用。
{% endstep %}

{% step %}

#### 保存

点击屏幕底部栏中的**保存**。打开或关闭 API 会在您保存后立即生效。
{% endstep %}
{% endstepper %}

Incogniton 应用程序必须打开并登录，API 才能工作。当您关闭应用程序时，API 也会停止。

### 更改 API 端口

API 默认监听端口 **35000**。要使用其他端口，请在**API 端口**字段中输入并点击**保存**。下次启动 Incogniton 时将使用新的端口号。

如果另一个程序已经使用了该端口，Incogniton 会显示端口已被占用的消息，并且不会启动 API。您可以通过以下两种方式解决此问题：

* 在**API 端口**中输入一个空闲端口。
* 开启**如果配置的端口被占用则使用下一个空闲端口**。Incogniton 将选择下一个空闲端口。当 API 运行时，选项卡会显示它实际使用的端口：“REST API 当前运行在端口 …”。

**Selenium 端口**字段（默认 4444）设置 Incogniton 在 API 旁边为 Selenium 脚本运行的 Selenium 网格的端口。

### 谁可以访问 API

API 仅监听 `127.0.0.1`（localhost）。网络上的其他计算机无法连接到它。您访问的网站也无法通过浏览器向其发送请求。在同一台计算机上运行的脚本、CLI 和 SDK 正常工作。

API 使用登录到应用程序的帐户工作。它可以看到您在应用程序中看到的相同配置文件。

### 使用 API 可以做什么

使用 API，您可以列出、创建、编辑、克隆和删除配置文件，启动和停止它们，读取和更改它们的 cookie，并为 Puppeteer、Playwright 或 Selenium 启动配置文件。调用配置文件需要其 ID：在配置文件列表中展开配置文件，然后点击**复制**旁边的**配置文件 ID**。

开发者文档中有端点、其参数和示例请求：

* [快速入门](https://api-docs.incogniton.com/getting-started/quickstart)：几分钟内完成您的第一个调用。
* [API 参考](https://api-docs.incogniton.com/apis)：每个端点。您也可以从自动化选项卡上的**API 文档**链接打开它。
* [自动化示例](https://api-docs.incogniton.com/how-to-guides/automation-examples)：即用型 Puppeteer、Playwright 和 Selenium 脚本。

### 使用 CLI 或 SDK

您不必自己编写 HTTP 调用：

* **Incogniton CLI**：在终端中以命令形式运行相同的操作。点击自动化选项卡上的**下载 CLI**；安装后，当应用程序启动时，它会自动更新。请参阅 [CLI 文档](https://api-docs.incogniton.com/cli)。
* [**JavaScript 和 Python SDK**](https://docs.incogniton.com/documentation/chinese-documentation/zi-dong-hua-api-he-sdk/javascript-and-python-sdk.md)：从代码中调用 API。
* [**连接 AI 客户端 (MCP)**](https://docs.incogniton.com/documentation/chinese-documentation/zi-dong-hua-api-he-sdk/connect-ai-clients-mcp.md)：让 Claude 或 Cursor 等 AI 客户端管理您的配置文件。
