📖 BrowserIP 文件
🌐 繁體中文

API 參考

Base URL:https://browserip.com。驗證:先 POST /api/auth/login 登入,伺服器下發 sid cookie,後續請求帶 cookie 即可。也可以用控制台「API Keys」頁生成的 Key:請求頭 Authorization: Bearer bip_…,無需 cookie(Key 只顯示一次,請妥善保存)。

啟動 POST /api/sessions/

curl -b cookies.txt -X POST https://browserip.com/api/sessions/ \
  -H 'Content-Type: application/json' -d '{}'

成功(有閒置席位)→ 200:

{
  "session": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "status": "ready",
    "region": "default",
    "token": "…",
    "cdp_url": "https://browserip.com/s/123e4567-e89b-12d3-a456-426614174000/…",
    "view_url": "/view/123e4567-e89b-12d3-a456-426614174000/…",
    "created_at": "2026-10-19T00:00:00.000Z",
    "last_activity": "2026-10-19T00:00:00.000Z"
  }
}

無閒置席位、已觸發擴容 → 202 {"session": {...}, "queue_position": 1}(輪詢 GET /api/sessions/:id 等 status 變 ready)。錯誤:402 insufficient_credits(餘額不足)、429 too_many_sessions、503 no_capacity。

查詢工作階段 GET /api/sessions/:id

{"session": {"id": "123e4567-e89b-12d3-a456-426614174000", "status": "ready", "cdp_url": "https://browserip.com/s/123e4567-e89b-12d3-a456-426614174000/…", …}}

關機 DELETE /api/sessions/:id

curl -b cookies.txt -X DELETE https://browserip.com/api/sessions/123e4567-e89b-12d3-a456-426614174000
→ {"ok": true}

查詢用戶資訊 GET /api/auth/me

{"user": {"id": "u_x", "email": "you@example.com", "hours": 4.5, "credits": 0, "account_type": "personal", "credit_rate_per_hour": null, "is_admin": false, "created_at": "…"}} 

查詢餘額 GET /api/billing/balance

返回目前餘額:個人用戶為 hours(小時),企業/管理員為 credits,並附 account_type 與企業費率 credit_rate_per_hour。