# 云浏览器开放 API

通过 MoreLogin 开放 API 启动、停止、连接和查询 MoreLogin 云浏览器环境。

云浏览器会将 MoreLogin 浏览器环境运行在远端主机上。启动环境后，您可以通过 CDP（Chrome DevTools 协议）连接该环境，并使用 Puppeteer 或 Playwright 等自动化框架进行操作。

**Base URL**：`https://api.morelogin.com`

使用 OAuth2 Bearer token 进行鉴权。详情请参阅[身份验证](../Getting%20Started/authentication.md)。


Version: 1.0.0

## Servers

```
https://api.morelogin.com
```

## Download OpenAPI description

[云浏览器开放 API](https://guide.morelogin.com/_bundle/@l10n/zh/API%20Reference/Cloud%20Browser/open-api.yaml)

## Cloud Browser

启动、停止、连接和查询云浏览器环境

### 启动云浏览器

 - [POST /cloudbrowser/start](https://guide.morelogin.com/zh/api-reference/cloud-browser/open-api/cloud-browser/startcloudbrowser.md): 启动云浏览器环境。环境会先进入 STARTING 状态，待远端浏览器就绪后转为 RUNNING。

启动过程是异步的。请轮询分页查询云浏览器环境以检查 cloudBrowserStatus，待环境变为 RUNNING 后再调用连接云浏览器。

### 停止云浏览器

 - [POST /cloudbrowser/stop](https://guide.morelogin.com/zh/api-reference/cloud-browser/open-api/cloud-browser/stopcloudbrowser.md): 停止运行中的云浏览器环境。将 force 设为 true 可强制释放环境，无需等待其正常关闭。

### 分页查询云浏览器环境

 - [POST /cloudbrowser/page](https://guide.morelogin.com/zh/api-reference/cloud-browser/open-api/cloud-browser/pagecloudbrowserenvironments.md): 分页查询云浏览器环境。支持按环境序号、环境 ID、环境名称、关键词和分组进行过滤。

### 连接云浏览器

 - [POST /cloudbrowser/connect](https://guide.morelogin.com/zh/api-reference/cloud-browser/open-api/cloud-browser/connectcloudbrowser.md): 返回运行中云浏览器环境的连接信息。使用返回的 cdpUrl 可通过 Chrome DevTools 协议接入自动化框架（Puppeteer、Playwright、Selenium）。

环境必须处于 RUNNING 状态。如有需要，请先通过启动云浏览器启动。