ClonBrowser

English EN 中文 (中国) 中文
  2. Home
  4. Docs
  6. ClonBrowser
  8. 自动化
  10. Open API

Open API

内容纲要

Open API

我们的API可以协助用户以编程方式读写账户配置信息、启动和关闭浏览器，查询账户，以及其他基本接口。它还可以被用于与 Selenium 和 Puppeteer 等自动化框架结合使用，实现浏览器自动化。

使用前需要检查登录的账户是否有API功能权限、检查接口状态是否正常。当状态栏为绿色的“已开启”时表示可生成API，在该状态下点击“重新生成API”

参数讲解:

  • API的所有参数都是字符串类型的。
  • POST请求的内容为JSON格式。
  • 非必须的参数是可选的，可以省略。
  • 接口调用限制:访问频率： 所有接口每秒最多有1次请求。

使用文档

请求头

参数 说明 使用说明
X-API-KEY 是 api-key

客户端接口

API接口状态

API

Method Path
HEAD /v1/app-keys

Request

Request（200）可用

Request（403）不可用

申请API Key

API

Method Path
POST /v1/app-keys

Response

Body

名字 类型 描述
key 字符串 32位 key 
{
    "model":"AppKey",
    "key":"3xxxxxxxxxx",
}

启动浏览器

API

Method Path
POST /v1/browsers/{id}

Request

Path

字段名 类型 描述 是否为空 验证规则
id 字符串 profile id 否 长度32位

Body

名字 类型 描述 是否为空 验证规则
headless 布尔值 无头模式 是 
{
    "headless?":true
}

Response

Body

名字 类型 描述
webdriver 字符串 webdriver的绝对路径
devtools 字符串 cdp协议接入地址
selenium 字符串 webdriver接入地址 
{
    "webdriver":"xxxxxxx",
    "devtools":"ws://127.0.0.1:port",
    "selenium":"127.0.0.1:2232" 
}

浏览器状态

API

Method Path
GET /v1/browsers/{id}

Request

Path

字段名 类型 描述 是否为空 验证规则
id 字符串 profile id 否 长度32位

Response

Body

名字 类型 描述
webdriver 字符串 webdriver的绝对路径
devtools 字符串 cdp协议接入地址
selenium 字符串 webdriver接入地址 
{
    "webdriver":"xxxxxxx",
    "devtools":"ws://127.0.0.1:port",
    "selenium":"127.0.0.1:2232" 
}

Response (404)

如果浏览器没开404

浏览器关闭

API

Method Path
DELETE /v1/browsers/{id}

Request

Path

字段名 类型 描述 是否为空 验证规则
id 字符串 profile id 否 长度32位

Response （200）

清除浏览器缓存

API

Method Path
DELETE /v1/browsers/{id}/caches

Request

Path

字段名 类型 描述 是否为空 验证规则
id 字符串 profile id 否 长度32位

Body

字段名 类型 描述 是否为空 验证规则
cookies 布尔值 删除远程cookie 是
bookmarks 布尔值 删除收藏夹 是 
{

}

Response （200）

How can we help?