### Create Linux Browser Window Example

Source: https://doc2.bitbrowser.cn/jiekou/request.html

Example parameters for creating a Linux browser window via the /browser/update API. Features browser fingerprint and no proxy configuration.

```json
// 接口：/browser/update
{
  "name": "Linux browser",
  "browserFingerPrint": {
    "coreVersion": "124",
    "ostype": "PC",
    "os": "Linux x86_64"
  },
  "proxyMethod": 2,
  "proxyType": "noproxy"
}
```

--------------------------------

### Create Mac Browser Window Example

Source: https://doc2.bitbrowser.cn/jiekou/request.html

Example parameters for creating a Mac browser window using the /browser/update API. Includes browser fingerprint and no proxy settings.

```json
// 接口：/browser/update
{
  "name": "mac browser",
  "browserFingerPrint": {
    "coreVersion": "118",
    "ostype": "PC",
    "os": "MacIntel",
    "hardwareConcurrency": "10"
  },
  "proxyMethod": 2,
  "proxyType": "noproxy"
}
```

--------------------------------

### Create Windows Browser Window Example

Source: https://doc2.bitbrowser.cn/jiekou/request.html

Example parameters for creating a Windows browser window using the /browser/update API. Specifies browser fingerprint details and no proxy.

```json
// 接口：/browser/update
{
  "name": "windows browser",
  "browserFingerPrint": {
    "coreVersion": "118",
    "ostype": "PC",
    "os": "Win32",
    "osVersion": "11,10"
  },
  "proxyMethod": 2,
  "proxyType": "noproxy"
}
```

--------------------------------

### Create iPhone Browser Window Example

Source: https://doc2.bitbrowser.cn/jiekou/request.html

Example parameters for creating an iPhone browser window using the /browser/update API. Includes specific iOS fingerprint details, resolution, and no proxy.

```json
// 接口：/browser/update
{
  "name": "iphone browser",
  "browserFingerPrint": {
    "coreVersion": "118",
    "ostype": "IOS",
    "os": "iPhone",
    "openWidth": 500,
    "openHeight": 900,
    "resolutionType": "1",
    "resolution": "360x780",
    "devicePixelRatio": 3
  },
  "proxyMethod": 2,
  "proxyType": "noproxy"
}
```

--------------------------------

### Cloud Phone Synchronizer - Operation Guide (Text Tutorial)

Source: https://doc2.bitbrowser.cn/%E2%9A%92yunshoujitongbuqi.html

Step-by-step instructions with images for operating the Cloud Phone Synchronizer.

```APIDOC
## Cloud Phone Synchronizer - Operation Guide (Text Tutorial)

### Description
This section provides a detailed, image-assisted guide for using the Cloud Phone Synchronizer.

### Content
- Cloud Phone Synchronizer Introduction
- Cloud Phone Environment Management
  - Opening Cloud Phone Environment Packages
  - Creating Cloud Phone Environments
  - Basic Functions of Phone Environments
    - Modifying Serial Number
    - Modifying Environment Name
    - Modifying Group
    - Modifying Proxy Information
    - Modifying Environment Remarks
    - Modifying Environment Configuration
    - Opening/Closing Phone Environments
    - Searching Environments
    - Customizing Display Columns
    - Rearranging Windows
    - File Management
    - Setting Favorite Environments
    - Setting Employee Allowances for Creating Phone Environments
- Monthly Computing Power Management
  - Purchasing Monthly Computing Power
  - Basic Functions of Monthly Computing Power
    - Querying Computing Power
    - Modifying Computing Power Name
    - Modifying Computing Power Remarks
    - Automatic Renewal
    - Renewing Computing Power
    - Deleting Computing Power
- Phone Environment Grouping
  - Adding Phone Environment Groups
  - Querying Phone Environment Groups
  - Basic Operations for Environment Groups
- Basic Functions of Cloud Phone Interface
- Cloud Phone Billing
- Proxy IP Settings
  - How to Set Up 922 S5 Proxy
```

--------------------------------

### Cloud Phone Synchronizer - Operation Guide (Video Tutorial)

Source: https://doc2.bitbrowser.cn/%E2%9A%92yunshoujitongbuqi.html

Video tutorials demonstrating how to operate the Cloud Phone Synchronizer.

```APIDOC
## Cloud Phone Synchronizer - Operation Guide (Video Tutorial)

### Description
This section provides video tutorials that guide users through the operation of the Cloud Phone Synchronizer.
```

--------------------------------

### Local Service Guide

Source: https://doc2.bitbrowser.cn/question.html

Information and guide for the local service, including a demo download link.

```APIDOC
## Local Service Guide

### Description
Guide for the local service with a demo download.

### Resources
- [Local Service Guide (demo download)](link_to_demo_download)
```

--------------------------------

### Headless Mode Guide

Source: https://doc2.bitbrowser.cn/anshijifei.html

Information and guidance on using the browser in headless mode.

```APIDOC
## Headless Mode Guide

### Description
Documentation on how to utilize the browser in headless mode for automated tasks.

### Usage
Refer to the provided guide for detailed instructions on headless mode operations.
```

--------------------------------

### Headless Mode Guide

Source: https://doc2.bitbrowser.cn/xghjpz.html

Information and guidance on using the browser in headless mode for automated tasks.

```APIDOC
## Headless Mode Guide

This section provides instructions and examples for operating the browser in headless mode, which is useful for automation and scripting.

### Key Features

- **Automated Execution**: Run browser tasks without a visible UI.
- **Scripting Support**: Integrate with scripts for batch processing.
- **API Integration**: Use API endpoints to control headless browser instances.
```

--------------------------------

### Get Installed App List

Source: https://doc2.bitbrowser.cn/jiekou/cloud-phone.html

Retrieves a list of installed apps on the cloud phone. This only fetches user-installed apps, not system-preinstalled ones.

```APIDOC
## Get Installed App List

Retrieves a list of installed apps on the cloud phone. This only fetches user-installed apps, not system-preinstalled ones.

**POST** `/phone/getInstalledAppList`

### Parameters

#### Request Body

- **id** (string) - Required - The cloud phone environment ID.

### Request Example

```json
{
  "id": "string"
}
```
```

--------------------------------

### Get Installed App List

Source: https://doc2.bitbrowser.cn/jiekou/cloud-phone.html

Retrieves a list of installed applications on the cloud phone. This API only returns user-installed apps, not system-preinstalled apps. Requires the environment ID.

```json
{
  "id": "string"
}
```

--------------------------------

### Install App

Source: https://doc2.bitbrowser.cn/jiekou/cloud-phone.html

Installs an app from the app market onto the cloud phone. Copy the app ID of the desired version from the app market to use this interface for automatic installation.

```APIDOC
## Install App

Installs an app from the app market onto the cloud phone. Copy the app ID of the desired version from the app market to use this interface for automatic installation.

**POST** `/phone/installApp`

### Parameters

#### Request Body

- **id** (string) - Required - The cloud phone environment ID.
- **appId** (string) - Required - The app ID. Copy the version-specific app ID from the app market.

### Request Example

```json
{
  "id": "2c9cce44930a5b0e01930a7c95b0000a",
  "appId": "1855178384240701441"
}
```
```

--------------------------------

### Create Browser Window with Socks5 Proxy

Source: https://doc2.bitbrowser.cn/jiekou/request.html

This example shows how to create a new browser window and configure it with SOCKS5 proxy settings.

```APIDOC
## Create Browser Window with Socks5 Proxy

### Description
Creates a new browser window and configures it with SOCKS5 proxy details.

### Method
POST

### Endpoint
/browser/update

### Parameters
#### Request Body
- **name** (string) - Required - The name of the browser window.
- **browserFingerPrint** (object) - Required - The fingerprint configuration for the browser.
  - **coreVersion** (string) - Required - The core version of the browser.
  - **ostype** (string) - Required - The operating system type (e.g., "PC").
  - **os** (string) - Required - The specific operating system details.
  - **osVersion** (string) - Optional - The operating system version.
- **proxyMethod** (integer) - Required - The proxy method to use.
- **proxyType** (string) - Required - The type of proxy (e.g., "socks5").
- **host** (string) - Required - The proxy server host.
- **port** (integer) - Required - The proxy server port.
- **proxyUserName** (string) - Optional - The username for proxy authentication.
- **proxyPassword** (string) - Optional - The password for proxy authentication.

### Request Example
```json
{
  "name": "windows browser",
  "browserFingerPrint": {
    "coreVersion": "118",
    "ostype": "PC",
    "os": "Win32",
    "osVersion": "11,10"
  },
  "proxyMethod": 2,
  "proxyType": "socks5",
  "host": "1.2.3.4",
  "port": 1020,
  "proxyUserName": "abc",
  "proxyPassword": "def"
}
```
```

--------------------------------

### Install App

Source: https://doc2.bitbrowser.cn/jiekou/cloud-phone.html

Installs an application from the app market. Copy the application ID for the desired version from the app market and use it in this API call.

```json
{
  "id": "2c9cce44930a5b0e01930a7c95b0000a",
  "appId": "1855178384240701441"
}
```

--------------------------------

### Create Browser Window with API Dynamic IP Proxy

Source: https://doc2.bitbrowser.cn/jiekou/request.html

This example demonstrates creating a browser window and setting up a dynamic IP proxy using an API extraction link.

```APIDOC
## Create Browser Window with API Dynamic IP Proxy

### Description
Creates a new browser window and configures it to use a dynamic IP proxy fetched via an API extraction link.

### Method
POST

### Endpoint
/browser/update

### Parameters
#### Request Body
- **name** (string) - Required - The name of the browser window.
- **browserFingerPrint** (object) - Required - The fingerprint configuration for the browser.
  - **coreVersion** (string) - Required - The core version of the browser.
  - **ostype** (string) - Required - The operating system type (e.g., "PC").
  - **os** (string) - Required - The specific operating system details.
  - **osVersion** (string) - Optional - The operating system version.
- **ipCheckService** (string) - Optional - The IP checking service to use.
- **proxyMethod** (integer) - Required - The proxy method to use.
- **proxyType** (string) - Required - The type of proxy (e.g., "socks5").
- **dynamicIpUrl** (string) - Required - The URL to fetch dynamic IP information.
- **dynamicIpChannel** (string) - Required - The channel for the dynamic IP.
- **isDynamicIpChangeIp** (boolean) - Required - Whether to change IP dynamically.

### Request Example
```json
{
  "name": "windows browser",
  "browserFingerPrint": {
    "coreVersion": "118",
    "ostype": "PC",
    "os": "Win32",
    "osVersion": "11,10"
  },
  "ipCheckService": "ip123in",
  "proxyMethod": 3,
  "proxyType": "socks5",
  "dynamicIpUrl": "http://example.tiquip.com/tiqu",
  "dynamicIpChannel": "common",
  "isDynamicIpChangeIp": true
}
```
```

--------------------------------

### Cookie Formatting Example

Source: https://doc2.bitbrowser.cn/jiekou/fu-lu.html

This example demonstrates the expected structure for cookie objects. Keys must be camel-cased English letters. Both 'expires' and 'expirationDate' can specify the expiration time.

```javascript
// cookie字符串为JSON.stringfy后的数组对象，每一项为一个cookie对象
// cookie对象的key必须是驼峰命名的英文字母，重点关注
// expires与expirationDate字段都可表示过期时间，重点关注
[
    {
        "domain": ".instagram.com", // string
        "expirationDate": 1680060024.48996, // 必须为number，不可为null或者undefined
        "httpOnly": false,
        "name": "ig_nrcb",
        "path": "/",
        "secure": true,
        "session": false,
        "storeId": null, 
        "value": "1", // string
        "sameSite": "Strict" // 为标准的sameSite值或不填此字段，不可为0，null，false等假值
    }, {...}]

```

--------------------------------

### 比特浏览器 3.0.5 更新日志

Source: https://doc2.bitbrowser.cn/updatelog.html

本次更新新增了同步扩展应用数据功能，支持同窗口和跨窗口同步。系统设置性能监控移除了 CPU 监控。Local API 新增 `/browser/update/partial` 接口，支持只修改传入字段的值，支持批量修改。支持自动固定到任务栏，并优化了代理检测和 Google 登录问题。

```APIDOC
## Local API /browser/update/partial 接口新增

### Description
新增 Local API `/browser/update/partial` 接口，支持只修改传入字段的值，支持批量修改。

### Method
POST/GET (具体方法未指定，通常为 POST 或 GET)

### Endpoint
`/browser/update/partial`

### Parameters
#### Request Body
- **browserId** (string) - Required - 浏览器 ID
- **fields** (object) - Required - 需要更新的字段和值
```

--------------------------------

### Create Windows Browser with SOCKS5 Proxy

Source: https://doc2.bitbrowser.cn/jiekou/liu-lan-qi-jie-kou.html

Use this example to create a Windows browser instance with SOCKS5 proxy settings. Ensure the `browserFingerPrint` object is provided, and consider system compatibility for `coreVersion`.

```json
{
  "name": "windows browser",
  "proxyMethod": 2,
  "proxyType": "socks5",
  "host": "1.2.3.4",
  "port": 1020,
  "proxyUserName": "abc",
  "proxyPassword": "def",
  "browserFingerPrint": {
    "coreVersion": "130",
    "ostype": "PC",
    "os": "Win32",
    "osVersion": "11,10"
  }
}
```

--------------------------------

### Configure Window for Headless Mode

Source: https://doc2.bitbrowser.cn/headless.html

When creating or modifying a window, set the `url` to an empty string and `launchArgs` in `browserFingerPrint` to `--headless`. This prepares the window object for headless operation. Multiple arguments can be passed by separating them with commas.

```json
{
    url: "", 
    browserFingerPrint: {
        launchArgs: "--headless"
    }
}
```

--------------------------------

### Headless Mode API

Source: https://doc2.bitbrowser.cn/readme.html

Guide for using the headless mode of the browser.

```APIDOC
## Headless Mode Guide

### Description
Documentation on how to use the browser in headless mode.

### Usage
Refer to the provided documentation for instructions on setting up and utilizing the headless mode.
```

--------------------------------

### Get All Displays

Source: https://doc2.bitbrowser.cn/jiekou/liu-lan-qi-jie-kou.html

Retrieves a list of all connected displays without any parameters.

```APIDOC
## Get All Displays
**POST** : `/alldisplays`

### Description
Retrieves a list of all connected displays.

### Method
POST

### Endpoint
`/alldisplays`

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (array) - An array of display objects, each containing details like id, label, bounds, workArea, etc.

### Response Example
```json
{
  "success": true,
  "data": [
    {
      "id": 1,
      "label": "Built-in Retina Display",
      "bounds": {
        "x": 0,
        "y": 0,
        "width": 1728,
        "height": 1117
      },
      "workArea": {
        "x": 0,
        "y": 38,
        "width": 1728,
        "height": 1004
      },
      "accelerometerSupport": "unknown",
      "monochrome": false,
      "colorDepth": 30,
      "colorSpace": "{primaries:BT709, transfer:SRGB_HDR, matrix:RGB, range:FULL}",
      "depthPerComponent": 10,
      "size": {
        "width": 1728,
        "height": 1117
      },
      "displayFrequency": 120,
      "workAreaSize": {
        "width": 1728,
        "height": 1004
      },
      "scaleFactor": 2,
      "rotation": 0,
      "internal": true,
      "touchSupport": "unknown"
    }
  ]
}
```
```

--------------------------------

### Create Android Browser Window

Source: https://doc2.bitbrowser.cn/jiekou/request.html

This example demonstrates how to create a new Android browser window with specified fingerprint and proxy settings.

```APIDOC
## Create Android Browser Window

### Description
Creates a new browser window with Android fingerprint and proxy configurations.

### Method
POST

### Endpoint
/browser/update

### Request Body
- **name** (string) - Required - The name of the browser window.
- **browserFingerPrint** (object) - Required - The fingerprint configuration for the browser.
  - **coreVersion** (string) - Required - The core version of the browser.
  - **ostype** (string) - Required - The operating system type (e.g., "Android").
  - **os** (string) - Required - The specific operating system details.
  - **openWidth** (integer) - Required - The width of the browser window.
  - **openHeight** (integer) - Required - The height of the browser window.
  - **resolutionType** (string) - Required - The type of resolution.
  - **resolution** (string) - Required - The screen resolution.
  - **devicePixelRatio** (integer) - Required - The device pixel ratio.
- **proxyMethod** (integer) - Required - The proxy method to use.
- **proxyType** (string) - Required - The type of proxy (e.g., "noproxy").

### Request Example
```json
{
  "name": "android browser",
  "browserFingerPrint": {
    "coreVersion": "118",
    "ostype": "Android",
    "os": "Linux armv81",
    "openWidth": 500,
    "openHeight": 900,
    "resolutionType": "1",
    "resolution": "360x780",
    "devicePixelRatio": 2
  },
  "proxyMethod": 2,
  "proxyType": "noproxy"
}
```
```

--------------------------------

### Opening a Browser in Headless Mode

Source: https://doc2.bitbrowser.cn/headless.html

To use headless mode, you need to pass the `--headless` argument in the `args` parameter when calling the `/browser/open` interface. It is recommended to also use `ignoreDefaultUrls` to prevent errors, as headless mode does not support multiple URLs on startup.

```APIDOC
## Using Headless Mode

### Method
POST

### Endpoint
`/browser/open`

### Description
Opens a browser instance in headless mode.

### Parameters
#### Request Body
- **id** (string) - Required - Unique identifier for the operation.
- **args** (array of strings) - Optional - Command-line arguments for the browser. Include `--headless` for headless mode.
- **queue** (boolean) - Optional - Whether to queue the request.
- **ignoreDefaultUrls** (boolean) - Required - Set to `true` to prevent errors in headless mode. Do not configure `newPageUrl`.

### Request Example
```json
{
    "id": "3baa6e990fee4e839c72722c8dc18019",
    "args": ["--headless"],
    "queue": true,
    "ignoreDefaultUrls": true
}
```

### Response
#### Success Response (200)
Indicates the browser was opened successfully. Specific response details depend on the API implementation.
```

--------------------------------

### Get Log Detail

Source: https://doc2.bitbrowser.cn/jiekou/local-db-api.html

Retrieves the details of a specific log entry.

```APIDOC
## Get Log Detail

### Description
Retrieves the details of a specific log entry.

### Method
POST

### Endpoint
/extralog/detail

### Parameters
#### Request Body
- **id** (int) - Required - The ID of the log to retrieve.
- **name** (string) - Optional - The name of the log (used for filtering or identification).

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.
- **data** (object) - Contains the log details.
  - **id** (int) - The log record ID.
  - **log_username** (string) - The username associated with the log.
  - **log_userid** (string) - The user ID associated with the log.
  - **created_time** (string) - The timestamp when the log was created.
  - **log_name** (string) - The name of the log.
  - **log_key** (string) - A key identifier for the log.
  - **log_type** (string) - The type of the log.
  - **log_value** (string) - The value or content of the log.
  - **log_desc** (string) - A description of the log.
  - **log_remark** (string) - Remarks associated with the log.
  - **log_extra_info** (string) - Additional information for the log.

### Response Example
```json
{
  "success": true,
  "data": {
    "id": 8,
    "log_username": "username",
    "log_userid": "3dsd3dsdd3dsdsdssds3dsssddsdsd",
    "created_time": "2024-07-03 10:11:32",
    "log_name": "i am name",
    "log_key": "33",
    "log_type": "Browser",
    "log_value": "我是修改的",
    "log_desc": "i am a desc",
    "log_remark": "remark",
    "log_extra_info": "0.0"
  }
}
```
```

--------------------------------

### Create Linux Browser Window

Source: https://doc2.bitbrowser.cn/jiekou/request.html

Example parameters for creating a new Linux browser window. This includes browser fingerprint settings specific to Linux and proxy configuration.

```APIDOC
## Create Linux Browser Window

### Description
Example parameters for creating a new Linux browser window. This includes browser fingerprint settings specific to Linux and proxy configuration.

### Endpoint
/browser/update

### Request Body
- **name** (string) - Required - The name of the browser window.
- **browserFingerPrint** (object) - Required - Browser fingerprint details.
  - **coreVersion** (string) - Required - The core version of the browser.
  - **ostype** (string) - Required - The operating system type (e.g., 'PC').
  - **os** (string) - Required - The specific operating system (e.g., 'Linux x86_64').
- **proxyMethod** (integer) - Required - The proxy method to use.
- **proxyType** (string) - Required - The type of proxy (e.g., 'noproxy').

### Request Example
```json
{
  "name": "Linux browser",
  "browserFingerPrint": {
    "coreVersion": "124",
    "ostype": "PC",
    "os": "Linux x86_64"
  },
  "proxyMethod": 2,
  "proxyType": "noproxy"
}
```
```

--------------------------------

### 比特浏览器 5.0.4 更新日志

Source: https://doc2.bitbrowser.cn/updatelog.html

本次更新修复了 RPA 计划执行问题，优化了 RPA 功能和窗口重启，解决了 Cookie 不保存、代理检测问题，并新增了系统设置、扩展中心同步、偏好设置、窗口排列、双重登录验证等功能。同时 `/browser/open` 接口取消了 extractIp 参数，并增加了 pid 返回参数。

```APIDOC
## /browser/open 接口更新

### Description
`/browser/open` 接口取消了 `extractIp` 参数，默认提取 IP。增加了打开窗口的 `pid` 返回参数。

### Method
POST/GET (具体方法未指定，通常为 POST 或 GET)

### Endpoint
`/browser/open`

### Parameters
#### Removed Parameters
- `extractIp` (boolean) - 已移除，默认提取 IP

#### Added Parameters
- `pid` (string) - 返回打开窗口的进程 ID
```

--------------------------------

### Get All Displays

Source: https://doc2.bitbrowser.cn/jiekou/liu-lan-qi-jie-kou.html

Retrieves a list of all connected displays and their properties. No parameters are required.

```json
{
  "success": true,
  "data": [
    {
      "id": 1,
      "label": "内建视网膜显示器",
      "bounds": {
        "x": 0,
        "y": 0,
        "width": 1728,
        "height": 1117
      },
      "workArea": {
        "x": 0,
        "y": 38,
        "width": 1728,
        "height": 1004
      },
      "accelerometerSupport": "unknown",
      "monochrome": false,
      "colorDepth": 30,
      "colorSpace": "{primaries:BT709, transfer:SRGB_HDR, matrix:RGB, range:FULL}",
      "depthPerComponent": 10,
      "size": {
        "width": 1728,
        "height": 1117
      },
      "displayFrequency": 120,
      "workAreaSize": {
        "width": 1728,
        "height": 1004
      },
      "scaleFactor": 2,
      "rotation": 0,
      "internal": true,
      "touchSupport": "unknown"
    },
    {
      "id": 2,
      "label": "HandaCai",
      "bounds": {
        "x": -1920,
        "y": 37,
        "width": 1920,
        "height": 1080
      },
      "workArea": {
        "x": -1920,
        "y": 62,
        "width": 1920,
        "height": 1055
      },
      "accelerometerSupport": "unknown",
      "monochrome": false,
      "colorDepth": 24,
      "colorSpace": "{primaries:BT709, transfer:SRGB, matrix:RGB, range:FULL}",
      "depthPerComponent": 8,
      "size": {
        "width": 1920,
        "height": 1080
      },
      "displayFrequency": 60,
      "workAreaSize": {
        "width": 1920,
        "height": 1055
      },
      "scaleFactor": 1,
      "rotation": 0,
      "internal": false,
      "touchSupport": "unknown"
    }
  ]
}
```