API详解

蜂巢指纹浏览器NestBrowser Local API V1

功能概述

蜂巢指纹浏览器NestBrowser支持本地Local API的功能,帮助用户通过程序化的方式来读写账号配置信息、启动和关闭浏览器、查询账号等基础API功能,还可以配合Selenium和Puppeteer等自动化框架来实现浏览器操作的自动化,拥有高级API权限的用户还可以使用更多功能接口以及定制化的功能。

使用方法

API接口状态

基本信息

Path: /status

Method: GET

接口描述:用于检查API接口的可用性

返回数据


//检查可用
{
  "code":200,
  "msg":"success"
}

浏览器

启动浏览器

基本信息

Path: /api/v1/browser/start

Method: GET

接口描述:用于启动账号对应的浏览器,需要指定账号ID,启动成功后可以获取浏览器debug接口用于执行selenium和puppeteer自动化。 Selenium需要使用到对应内核版本匹配的Webdriver。需更新到应用版本3.4.1以上,启动浏览器后可在返回值中拿到对应的Webdriver的路径

请求参数

Query 非必需参数可以不传递

参数名称 必需 默认值 示例 说明 备注
ids - 123,234,345 通过账号ID启动,账号导入成功后生成的唯一ID
uuids - xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxxxx 通过序号启动,如果已传递账号ID则优先用账号ID

返回数据

// 执行成功
{
"code": 200,
"msg": "请求成功",
"data": [
    {
        "uuid": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
        "name": "name",
        "success": "ok",
        "duration": "2.987 s",
        "id": 241,
        "ws": {
            "url": "ws://localhost:xxxx/devtools/browser/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx", //浏览器debug接口,可用于puppeteer自动化
            "selenium": "localhost:xxxx"    //devtools接口参数
        },
        "debug_port": "xxxx",
        "webdriver": "/xxxx/xxx/xxx/chromedriver"// webdriver本地路径,nestbrowser会自带一个webdrive
    }
        ]
}

//执行失败
{
  "code":-1,
  "data":{},
  "msg":"failed"
}

关闭用户的浏览器

基本信息

Path: /api/v1/browser/stop

Method: GET

接口描述:用于关闭账号对应的浏览器,需要指定账号ID

请求参数

Query 非必需参数可以不传递

参数名称 必需 默认值 示例 说明
ids - 123,234,345 账号ID,账号导入成功后生成的唯一ID
uuids - xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxxxx 通过序号关闭,如果已传递账号ID则优先用账号ID

返回数据


//执行成功
{
  "code":200,
  "data":{},
  "msg":"success"
}

//执行失败
{
  "code":-1,
  "data":{},
  "msg":"failed"
}

检查启动状态

基本信息

Path: /api/v1/browser/active

Method: GET

接口描述:用于账号浏览器的启动状态,需要指定账号ID

请求参数

Query 非必需参数可以不传递

参数名称 必需 默认值 示例 说明
id - 123 账号ID,账号导入成功后生成的唯一ID
uuid - xxxxxxxx-xxxx-xxxx-xxxxxxxx 通过序号检查,如果已传递账号ID则优先用账号ID

返回数据


//执行成功
{
    "code": 200,
    "msg": "success",
    "data": {
        "uuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
        "ws": {
            "url": "ws://localhost:xxxx/devtools/browser/xxxxxxxx-xxxx-xxxx-xxxx-xxxx"
        },
        "debug_port": 000,
        "webdriver": "/xxx/xxx/xxx/chromedriver"
    }
}

//执行失败
{
  "code":-1,
  "data":{},
  "msg":"failed"
}

分组管理

添加分组

基本信息

Path: /api/v1/account-groups

Method: POST

接口描述:添加账号的分组,用于创建账号时将账号分组,名称不能重复,创建成功后将返回group_id分组ID,分组ID为0是系统创建的默认分组

请求参数

Body 非必需参数可以不传递,传参格式为JSON

参数名称 类型 必需 默认值 示例 说明
title string - 分组1 添加分组的名称

返回数据


//执行成功
{
    "code": 200,
    "msg": "success",
    "data": {
        "id": 83, //group_id 分组ID
        "title": "分组1",
        "remark": ""
    }
}

//执行失败
{
  "code":-1,
  "data":{},
  "msg":"failed"
}

修改分组

基本信息

Path: /api/v1/account-groups/:group_id

Method: PU

接口描述:修改分组信息,可以修改分组名称

请求参数

Body 非必需参数可以不传递,传参格式为JSON

参数名称 类型 必需 默认值 示例 说明
group_id number - 123 需要修改的分组ID
title string - 分组2 修改后的分组名称

返回数据


//执行成功
{
    "code": 200,
    "msg": "success",
    "data": {}
}

//执行失败
{
  "code":-1,
  "data":{},
  "msg":"failed"
}

查询分组

基本信息

Path: /api/v1/account-groups

Method: GET

接口描述:查询分组信息,分组信息包括分组ID和分组名称,其中分组ID用于添加账号时给账号分组,分组ID为0是系统创建的默认分组

请求参数

Query 非必需参数可以不传递

参数名称 必需 默认值 示例 说明
title - 分组1 指定分组名称查询分组,默认空查所有分组
page 1 1 页码默认1第一页
page_size 1 10 每页条数默认1条,最大2000

返回数据


//执行成功
{
    "code": 200,
    "msg": "success",
    "data": {
        "data": [
            {
                "id": 1, // 分组ID, 添加帐号时需要
                "title": "分组1",
                "remark": ""
            },
            {
                "id": 2,
                "title": "分组2",
                "remark": ""
            }
        ],
        "total": 9 // 总数
    }
}

//执行失败
{
"code":-1,
"data":{},
"msg":"failed"
}

账号管理

添加账号

基本信息

Path: /api/v1/accounts

Method: POST

接口描述:添加账号,支持配置平台账密和Cookie,代理ID和代理信息,指纹信息等等,添加成功后返回账号ID

请求参数

Body 非必需参数可以不传递,传参格式为JSON

参数名称 类型 必需 默认值 示例 说明 备注
name text - 帐号 A 对该账号的命名,限制100字,方便记忆管理
platform select - 'None',

'Other', 'Facebook', 'Google', 'Amazon', 'Tiktop', 'Vinted', 'Discord', 'Twitter', 'Aliexpress', 'Youtube', 'Ebay', 'Stripe', 'Paypal', 'Payoneer', 'Lazada', 'Shopify', 'Shoplineapp’ | 账号平台 | |

{
    // 必填
    "platform": "Facebook",
    "name": "环境1",
    "fingerprint": "{\"browser_version\":100,\"timezone\":\"auto\",\"webrtc\":\"disable\",\"location\":{\"setting\":\"allow\",\"locationIpAuto\":true,\"languageIpAuto\":true,\"accuracy\":10},\"font\":\"default\",\"responsive\":\"auto\",\"canvas\":\"min\",\"webgl\":{\"start\":122,\"length\":13,\"value\":1},\"webgl_config\":{\"setting\":\"customize\",\"vendor\":\"Intel Inc.\",\"renderer\":\"Intel(R) Iris(TM) Plus Graphics OpenGL Engine\",\"data\":{\"2849\":1,\"2884\":false,\"2885\":1029,\"2886\":2305,\"2928\":[0,1],\"2929\":false,\"2930\":true,\"2931\":1,\"2932\":513,\"2960\":false,\"2961\":0,\"2962\":519,\"2963\":4294967295,\"2964\":7680,\"2965\":7680,\"2966\":7680,\"2967\":0,\"2968\":4294967295,\"2978\":[0,0,300,150],\"3024\":true,\"3042\":false,\"3088\":[0,0,300,150],\"3089\":false,\"3106\":[0,0,0,0],\"3107\":[true,true,true,true],\"3317\":4,\"3333\":4,\"3379\":16384,\"3386\":[16384,16384],\"3408\":8,\"3410\":8,\"3411\":8,\"3412\":8,\"3413\":8,\"3414\":24,\"3415\":0,\"7936\":\"WebKit\",\"7937\":\"WebKit WebGL\",\"7938\":\"WebGL 2.0 (OpenGL ES 3.0 Chromium)\",\"10752\":0,\"32773\":[0,0,0,0],\"32777\":32774,\"32823\":false,\"32824\":0,\"32873\":null,\"32883\":2048,\"32936\":1,\"32937\":4,\"32938\":1,\"32939\":false,\"32968\":0,\"32969\":1,\"32970\":0,\"32971\":1,\"33170\":4352,\"33901\":[1,255.875],\"33902\":[1,1],\"34016\":33984,\"34024\":16384,\"34045\":16,\"34047\":16,\"34068\":null,\"34076\":16384,\"34467\":{},\"34816\":519,\"34817\":7680,\"34818\":7680,\"34819\":7680,\"34852\":8,\"34877\":32774,\"34921\":16,\"34930\":16,\"34964\":null,\"34965\":null,\"35071\":2048,\"35076\":-8,\"35077\":7,\"35371\":15,\"35373\":15,\"35374\":75,\"35375\":75,\"35376\":65536,\"35377\":249856,\"35379\":249856,\"35380\":256,\"35657\":4096,\"35658\":4096,\"35659\":60,\"35660\":16,\"35661\":80,\"35724\":\"WebGL GLSL ES 3.00 (OpenGL ES GLSL ES 3.0 Chromium)\",\"35725\":null,\"35968\":4,\"35978\":64,\"35979\":4,\"36003\":0,\"36004\":4294967295,\"36005\":4294967295,\"36006\":null,\"36007\":null,\"36063\":8,\"36183\":16,\"36347\":1024,\"36348\":15,\"36349\":1024,\"37154\":128,\"37157\":128,\"37440\":false,\"37441\":false,\"37443\":37444,\"37445\":\"Intel Inc.\",\"37446\":\"Intel(R) Iris(TM) Plus Graphics OpenGL Engine\"}},\"track\":\"off\",\"audio_context\":\"1.10\",\"audio_device\":\"on\",\"client_rects\":\"on\",\"sppech_voices\":\"on\",\"cpu\":\"auto\",\"ram\":\"auto\",\"device_name\":\"off\",\"flash\":\"off\",\"allow_scan_ports\":\"off\",\"system_os\":\"windows\"}",

    // 选填 ⬇️
    "account": "username",
    "password": "password",
    "cookie": "123=123",
    "comment": "备注",
    "proxy_type": "{\"type\":\"socks5\",\"host\":\"127.0.0.1\",\"port\":\"1080\",\"user\":\"user\",\"password\":\"password\"}",
    "user_agent": "Mozilla/5.0 (Windows NT 10.0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/100.0.4896.136 Safari/537.36",
    "platform_url": "https://www.xxxxx.com/", //platform: Other 时,自定义连接
}

返回数据


//执行成功
{
  "code": 0,
  "data": {
    "id": 1  //账号添加成功之后的唯一ID
        "uuid" "xxxxx-xxxx-xxxx-xxxxx" // 帐号uuid 
  }
  "msg": "Success"
}

//执行失败
{
  "code":-1,
  "data":{},
  "msg":"failed"
}

修改账号

基本信息

Path: /api/v1/accounts/:id

Method: PUT

接口描述:修改账号,支持更新账密和Cookie,代理信息,指纹信息等等

请求参数

Body 非必需参数可以不传递,传参格式为JSON

参数名称 类型 必需 默认值 示例 说明 备注
id number - 1 需要修改的账号的ID
name text - user A 对该账号的命名,限制100字,方便记忆管理
platform select - 'None',

'Other', 'Facebook', 'Google', 'Amazon', 'Tiktop', 'Vinted', 'Discord', 'Twitter', 'Aliexpress', 'Youtube', 'Ebay', 'Stripe', 'Paypal', 'Payoneer', 'Lazada', 'Shopify', 'Shoplineapp’ | 账号平台 | | | platform_url | text | 否 | - | | | | | account | text | 否 | - | account | 账号密码或者Cookie至少填一个;账号允许重复则都可不填 | | | password | text | 否 | - | 123456 | 账号密码或者Cookie至少填一个;账号允许重复则都可不填 | | | cookie | text | 否 | - | [ { “domain”: “.baidu.com”, “expirationDate”: , | | |

返回数据


//执行成功
{
  "code": 200,
  "data": {
  }
  "msg": "Success"
}

//执行失败
{
  "code":-1,
  "data":{},
  "msg":"failed"
}

查询账号

基本信息

Path: /api/v1/accounts

Method: GET

接口描述:查询已添加账号的信息,代理信息和代理ID

请求参数

Query 非必需参数可以不传递

参数名称 必需 默认值 示例 说明
ids - 1,2,3 指定分组ID查询账号,默认不传递则查询所有分组的账号
uuids - xxxx-xxx-xx 指定序号查询
page 1 1 页码,默认1,数量多需要翻页时用
page_size 1 50 每页大小,默认每页1 ,最大100

返回数据


//执行成功
{
    "code": 200,
    "data": {
        "total": 2,
        "data": [
            {
                "id": 1,
                "name": "名称",
                "account": "",
                "uuid": "xxxx-xxxx-xxxx-xxxx-xxxx",
                "password": "",
                "platform": "Facebook",
                "platform_url": "https://www.facebook.com/",
                "cookie": "",
                "comment": "",
                "user_agent": "Mozilla/5.0(WindowsNT10.0;Win64;x64)AppleWebKit/537.36(KHTML,likeGecko)Chrome/993.0.3497.66Safari/537.36",
                "group_id": 0,
                "group_name": "",
                "proxy_type": {
                    "type": "noproxy",
                    "host": "127.0.0.1",
                    "port": "xxxx",
                    "user": "",
                    "password": "",
                    "country": "",
                    "city": "",
                    "province": "",
                    "country_ip": ""
                }
            },
        ]
    },
    "message": "操作成功",
    "success": true
}

//执行失败
{
  "code":-1,
  "data":{},
  "msg":"failed"
}

删除账号

基本信息

Path: /api/v1/accounts

Method: DELETE

接口描述:删除不需要的账号,支持批量删除,一次删除的数量不能超过100个

请求参数

Body 非必需参数可以不传递,传参格式为JSON

参数名称 类型 必需 默认值 示例 说明
ids list - 123,234

返回数据


//执行成功
{
  "code":0,
  "data":{},
  "msg":"success"
}

//执行失败
{
  "code":-1,
  "data":{},
  "msg":"failed"
}

删除账号缓存

基本信息

Path: /api/v1/accounts-xsession

Method: POST

接口描述:用于清除所有打开浏览器产生的本地缓存。为了账号安全,请确保在该设备中没有打开状态的浏览器下使用该接口。若磁盘空间不足,可使用该接口清除账号缓存释放空间

注意事项:该接口会删除所有本地账号缓存数据,请谨慎使用

返回数据


//执行成功
{
"code":0,
"msg":"success"
}

//执行失败
{
"code":-1,
"msg":"fail"
}

Build by 蜂巢指纹浏览器NestBrowser.

© 2019 all right reserved,powered by Gitbook本文档更新于: 2023-06-27 17:03

results matching ""

    No results matching ""