API 总览
Browserman REST API 的完整参考。
基础 URL
https://api.browserman.run所有 API 请求都应发送到此基础 URL。
身份认证
使用 Authorization 头中的 API 密钥进行身份验证：
bash
Authorization: Bearer YOUR_API_KEY示例：
bash
curl https://api.browserman.run/api/platforms \
-H "Authorization: Bearer sk_live_xxxxxxxxxxxx"获取 API 密钥
- 访问 app.browserman.run
- 在侧边栏点击 API 密钥
- 点击 + 新建密钥
- 复制并安全存储密钥
请求格式
头部
所有 POST/PUT 请求应包含：
Content-Type: application/json
Authorization: Bearer YOUR_API_KEY请求体
请求体应为有效的 JSON：
json
{
"platform": "twitter",
"tool": "createTweet",
"accountName": "my-account",
"parameters": {
"text": "你好世界！"
}
}响应格式
成功响应
json
{
"success": true,
"data": {
"taskId": "task_abc123",
"state": "pending",
"createdAt": "2024-01-15T10:30:00Z"
}
}错误响应
json
{
"success": false,
"error": {
"code": "ACCOUNT_NOT_FOUND",
"message": "未找到平台 'twitter' 的账号 'my-account'",
"details": {}
}
}核心端点
平台
获取关于支持的平台及其工具的信息。
bash
# 列出所有平台
GET /api/platforms
# 获取平台 schema
GET /api/platforms/schema
# 获取特定平台详情
GET /api/platforms/:platformId账号
管理你连接的社交媒体账号。
bash
# 列出所有账号
GET /api/accounts
# 获取账号详情
GET /api/accounts/:accountId
# 按平台过滤
GET /api/accounts?platform=twitter
# 删除账号
DELETE /api/accounts/:accountId任务
创建和管理自动化任务。
bash
# 创建任务
POST /api/tasks
# 获取任务状态
GET /api/tasks/:taskId
# 列出任务
GET /api/tasks
# 取消任务
DELETE /api/tasks/:taskId速率限制
API 速率限制（每个 API 密钥）：
- 免费层：100 请求/小时，1,000 请求/天
- 专业层：1,000 请求/小时，10,000 请求/天
- 企业层：自定义限制
响应中的速率限制头：
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1642248000错误代码
常见的错误代码：
| 代码 | HTTP 状态 | 描述 |
|---|---|---|
UNAUTHORIZED | 401 | 无效或缺少 API 密钥 |
FORBIDDEN | 403 | 权限不足 |
NOT_FOUND | 404 | 资源未找到 |
RATE_LIMITED | 429 | 请求过多 |
ACCOUNT_NOT_FOUND | 400 | 账号不存在 |
INVALID_PARAMETERS | 400 | 无效的请求参数 |
PLATFORM_ERROR | 502 | 平台特定错误 |
TIMEOUT | 504 | 任务执行超时 |
INTERNAL_ERROR | 500 | 服务器错误 |
常见模式
创建任务
请求：
bash
curl -X POST https://api.browserman.run/api/tasks \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"platform": "twitter",
"tool": "createTweet",
"accountName": "my-account",
"parameters": {
"text": "来自 Browserman 的问候！"
}
}'响应：
json
{
"success": true,
"data": {
"taskId": "task_abc123",
"state": "pending",
"createdAt": "2024-01-15T10:30:00Z"
}
}检查任务状态
请求：
bash
curl https://api.browserman.run/api/tasks/task_abc123 \
-H "Authorization: Bearer YOUR_API_KEY"响应：
json
{
"success": true,
"data": {
"taskId": "task_abc123",
"state": "completed",
"result": {
"success": true,
"output": "推文发布成功"
},
"createdAt": "2024-01-15T10:30:00Z",
"completedAt": "2024-01-15T10:30:15Z"
}
}OpenAPI Schema
获取完整的 OpenAPI schema：
bash
curl https://api.browserman.run/api/platforms/schema使用它来：
- 生成 API 客户端
- 验证请求
- 探索可用工具
- 构建集成
支持
- 文档：浏览这些指南
- API 状态：检查控制台以获取状态更新
- 支持：通过控制台联系
- 社区：通过控制台访问社区论坛