OpenAPI Document

Document Introduction

version	v1
address	http://127.0.0.1:37073

Online debugging document address

http://127.0.0.1:37073/swagger/index.html

Generic exception structure

{
     "model": "errors",
     "errors": {
         "model": "data.set",
         "datas": [
             {
                  "model": "error", 
                  "code": "error.code.xxxxxx",
                  "message": "error message"
             }
          ]
     }
}

Generic paging structure

Field	Type	Description
model	String	model
page	Object	page object
page.model	String	page object model
page.current	Number	current page number
page.size	Number	page size
page.total	Number	query total
page.total_page	Number	query total page number
result	Object	response item object
result.model	String	response item object model
result.datas	Array<?>	response item object array list
result.total	Number	item size

{
    "model": "grid.result",
    "page":{
      "current":0,
      "model": "page",
      "size": 0,
      "total":0,
      "total_page": 0
    },
    "result":{
      "datas":[

        ],
        "model": "data.set",
        "total":0
    }
}

Browser

Start browser

API

Method	Path
POST	/v1/browsers/{id}

Request

Path:

Field	Type	Description
id	String	browser id

Body:

Field	Type	Description
args	Array<String>	Additional startup parameters (This parameter can dynamically modify browser-related configurations such as proxy) If this parameter is not set, the userconfigured

example:

args:

setProxy: –proxy-server={proxyUrl}

{
      "args":[]
}

Response

Field	Type	Description
model	String	model
id	String	browser id
pid	Number	process id
extra	Object	extra data
remote_debugging_port	Number	remote debugging port
webdriver_path	String	webdriver path

{
            "model": "dynamicBrowser.info",
            "id": "1793926560227803137",
            "pid":19900,
        "extra":{
                "browser_extra":"f967687893566cdd9a95ffc8898a36cf.qT05+y69MZst
mJAtgMzHh9QMAXHVn4/gmyzCeKYraSbfl4eTqUX60ncSL9dXVpGV55Yy+2jVXI/oGiLgOMR
osCdoUQfT6p2ELKO6/9LBoLVVXi8/1rruga/xLeatscniJFTzXRO3JyacfrZqLWXvBIqmJT
RSrxtQdkXEgVYpOCSrsXOYVyMgJla41iuKw8qO7JrcjP1WDTbsoHcBDzSONvMEYD/VrswN2
hRyHcuVg3o="
                "id":""1793926560227803137"
            },
            "remote_debugging_port": 13707,
            "webdriver_path": "C:\\Users\\27172\\AppData\\Roaming\\ClonBrowserD
ata\\browsers\\chromium\\122\\chromedriver.exe"  
    }

Close browser

API

Method	Path
DELETE	/v1/browsers/{id}

Request

Path:

Field	Type	Description
id	String	browser id

Response

httpstatus 200

Close all browsers

API

Method	Path
DELETE	/v1/browsers

Request

no body

Response

httpstatus 200

Clear browser cache

Description: This method will clear the relevant data generated locally by the current

browser

API

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

Request

Path:

Field	Type	Description
id	String	browser id

Response

httpstatus 200

Get the list of open browsers

API

Method	Path
GET	/v1/browsers/launched

Request

no body

Response

Field	Type	Description
model	String	model
data	List<item>	opened browser items
item.model	String	item model
item.id	String	browser id
item.pid	Number	process id
item.extra	Object	extra
item.remote_debugging_port	Number	remote debugging port
item.webdriver_path	String	webdriver path

{
 "model": "browser.list",
 "data": [
 {
 "model": "dynamicBrowser.info",
 "id": "1793926560227803137",
 "pid": 5908,
 "extra": {
 "browser_extra": "83fa4681624a3ac8abeb19516b68dfb1.3v1b
sZ4sDR/CJiUbrH9/D6eBdOIkt4Y49sDuUhVEWGlHzQ+QDMsG5vhTycMUk/aD092mdFsvzPN
lRzGtTzmGCDsWEWBeW7hP/or5k9v085xiITUyWnwnu4PnTq2ZfXB89EaBGbAaT70W478KgW
t+e1UwXXS8xPHW1El5m6qI7TJSKTpndiMyE/pJi2QXLhpX6o5jkGwYMBs/gGjGHCXyMxnFb
dPkOA2Fm2nIcP1ZbKA=",
 "id": "1793926560227803137"
 },
 "remote_debugging_port": 13707,
 "webdriver_path": "C:\\Users\\27172\\AppData\\Roaming\\Clon
BrowserData\\browsers\\chromium\\122\\chromedriver.exe"
 }
 ]
}

Get the browser list of the currently logged in account

API

Method	Path
GET	/v1/browsers

Request

Params:

Field	Type	Description	Required	Validation
page	Number	page	false	1-1000
size	Number	page size	false	1-200
name	String	filter by name	false	1-255

Response

Generic paging structure

Grid<?>

Item

Field	Type	Description
id	String	browser id
serial_number	Number	browser serial number
name	String	browser name
remark	String	browser remark
item.extra	Object	extra
item.remote_debugging_port	Number	remote debugging port
item.webdriver_path	String	webdriver path
item.fingerprint_config	Object	fingerprint object
item.proxy	Object	proxy object
item.platform_accounts	Array<platform AccountObject>	platform account object list

fingerprint object

Field	Type	Description
language	String	browser language
kernel_brand	String	browser brand
kernel_version	Number	browser version
system_os	String	os name
system_version	Array<String>	os version

proxy object

Field	Type	Description
proxy_type	String	proxy type
address	String	proxy address
port	Number	proxy port
username	String	proxy username
password	String	proxy password
alias	String	proxy alias
remark	String	proxy remark

platform account object

Field	Type	Description
site_id	String	site id
custom_url	String	open site url
account	String	site account
password	String	site password
remark	String	site remark

{
 "model": "grid.result",
 "page": {
 "model": "page",
 "current": 1,
 "size": 1,
 "total": 20,
 "total_page": 20
 },
 "result": {
 "model": "data.set",
 "datas": [
 {
 "id": "1614889065354821634",
 "serial_number": 1,
 "name": "xxx",
 "remark": "",
 "fingerprint_config": {
 "language": "",
 "kernel_brand": "chrome",
 "kernel_version": 106,
 "system_os": "windows",
 "system_version": [
 "10"
 ]
 },
 "proxy": {
 "proxy_type": "https",
 "address": "proxyxxx.xx.com",
 "port": 5601,
 "username": "",
 "password": "",
 "alias": "",
 "remark": ""
 },
 "platform_accounts": []
 }
 ],
 "total": 1
 }
 }