BroSDK 文档
欢迎使用 BroSDK 文档!BroSDK 是一个基于 C++ 高性能浏览器环境管理和自动化平台。
架构概述
BroSDK 由以下核心组件组成:
flowchart LR
subgraph Client["客户端"]
App["用户应用
(C++/Go/TS)"] SDK["BroSDK SDK
(C++ DLL/SO)"] Core["浏览器内核
(Chromium)"] end subgraph Server["服务端"] API["BroSDK 服务器
(API Service)"] end App -- "1. 获取 User Sign" --> API API -- "2. 返回 JWT 令牌" --> App App -- "3. 传入 User Sign 初始化" --> SDK SDK --> Core style Client fill:#e1f5ff,stroke:#0066cc,stroke-width:2px style Server fill:#fff4e1,stroke:#cc6600,stroke-width:2px style App fill:#ffffff,stroke:#333,stroke-width:1.5px style SDK fill:#ffffff,stroke:#333,stroke-width:1.5px style Core fill:#ffffff,stroke:#333,stroke-width:1.5px style API fill:#ffffff,stroke:#333,stroke-width:1.5px
(C++/Go/TS)"] SDK["BroSDK SDK
(C++ DLL/SO)"] Core["浏览器内核
(Chromium)"] end subgraph Server["服务端"] API["BroSDK 服务器
(API Service)"] end App -- "1. 获取 User Sign" --> API API -- "2. 返回 JWT 令牌" --> App App -- "3. 传入 User Sign 初始化" --> SDK SDK --> Core style Client fill:#e1f5ff,stroke:#0066cc,stroke-width:2px style Server fill:#fff4e1,stroke:#cc6600,stroke-width:2px style App fill:#ffffff,stroke:#333,stroke-width:1.5px style SDK fill:#ffffff,stroke:#333,stroke-width:1.5px style Core fill:#ffffff,stroke:#333,stroke-width:1.5px style API fill:#ffffff,stroke:#333,stroke-width:1.5px
核心流程: 1. 用户使用 API Key 从 BroSDK 服务器换取 User Sign(JWT 令牌) 2. 使用 User Sign 初始化 SDK 3. 通过 SDK API 调用浏览器内核,创建和管理浏览器环境
快速开始
如果你是第一次使用,请从 快速开始 开始,了解如何:
- 注册账号并创建应用
- 获取 API Key
- 获取 User Sign
- 初始化 SDK
文档导航
用户指南
API 参考
集成指南
- 原生 C 集成 - 如何在 C/C++ 项目中集成 SDK
相关资源
核心资源
| 资源 | 链接 | 说明 |
|---|---|---|
| 🌐 官网 | https://www.brosdk.com | 官方网站 |
| 📦 C++ SDK | github.com/browsersdk/brosdk-sdk | 核心动态库(必需) |
| 📘 TypeScript SDK | github.com/browsersdk/brosdk-sdk-typescript | C++ SDK 的 TS 封装(需配合 C++ SDK 使用) |
| 🔧 浏览器内核 | github.com/browsersdk/brosdk-core | Chromium 内核 |
| 📖 SDK Demo | github.com/browsersdk/browser-sdk-demo | 示例代码 |
| 🚀 Go 服务端 SDK | github.com/browsersdk/brosdk-server-go | 服务端 API 封装 |
| 📚 SDK 参考文档 | sdk-reference.md | 完整 API 文档 |
技术支持
如果遇到问题,请:
- 查阅文档寻找答案
- 访问 GitHub Issues 提交问题
- 联系技术支持
功能特性
- 浏览器环境管理:创建、更新、查询、销毁浏览器环境
- 指纹配置:自定义浏览器指纹,避免被检测
- 代理支持:支持多种代理协议,实现 IP 切换
- 数据持久化:独立的环境数据,支持 Cookie、历史记录等
- 多种语言支持:提供 C、TypeScript 等多种语言 SDK
- 灵活的 API:服务端 API 和 SDK API 两种调用方式
贡献
欢迎贡献文档!请查看 GitHub 了解如何参与贡献。