API-Referenz

Quick Start

Connect your existing Puppeteer, Playwright, or CDP automation to BotCloud by swapping your WebSocket endpoint to wss://cloud.bots.win. No code rewrites — just one line change.

import puppeteer from "puppeteer-core";

const params = new URLSearchParams({
  token: process.env.BOTCLOUD_TOKEN,
  "--proxy-server": process.env.BOTCLOUD_PROXY,
  device_type: "mac",
});

const browser = await puppeteer.connect({
  browserWSEndpoint: `wss://cloud.bots.win?${params.toString()}`,
});

const page = await browser.newPage();
await page.goto("https://example.com");
await page.screenshot({ path: "screenshot.png" });
await browser.close();

Authentifizierung

Alle API-Endpunkte erfordern Bearer-Token-Authentifizierung

# All API endpoints require Bearer token authentication
curl -H "Authorization: Bearer your-user-token-here" \
  https://cloud.bots.win/api/quota

GET /api/quota

Überprüfen Sie verbleibende Quota vor dem Starten von Aufträgen

Response: Gibt Gesamtquota, verwendete, verbleibende Quota und Prozentsatz verwendet zurück

curl -H "Authorization: Bearer your-token" https://cloud.bots.win/api/quota

GET /api/usage

Erhalten Sie Nutzungsstatistiken für Reporting und Kostenanalyse

Response: Gibt Gesamtsitzungen, Gesamtminuten und aktive Sitzungsanzahl zurück

curl -H "Authorization: Bearer your-token" https://cloud.bots.win/api/usage

GET /api/history

Sitzungsverlauf für Audit-Trails abrufen

Parameters: Optionale Start- und End-Abfrageparameter (ISO 8601-Zeitstempel)

Response: Gibt Array von Sitzungsobjekten mit Dauer und Disconnect-Gründen zurück

curl -H "Authorization: Bearer your-token" https://cloud.bots.win/api/history

POST /api/user-data

Erstellen Sie einen neuen Benutzerdaten-Container für persistenten Browser-Zustand (Cookies, localStorage, etc.)

Response: Gibt die erstellte Benutzerdaten-ID und den Zeitstempel zurück

curl -X POST -H "Authorization: Bearer your-token" https://cloud.bots.win/api/user-data

GET /api/user-data

Listen Sie alle Benutzerdaten-Container für den authentifizierten Benutzer auf

Response: Gibt Array von Benutzerdaten-Objekten mit Quota-Informationen zurück

curl -H "Authorization: Bearer your-token" https://cloud.bots.win/api/user-data

DELETE /api/user-data/:id

Löschen Sie einen Benutzerdaten-Container und geben Sie Quota frei

Response: Gibt Erfolgsstatus zurück

curl -X DELETE -H "Authorization: Bearer your-token" \
  https://cloud.bots.win/api/user-data/udd_abc123xyz789defg

Framework Integration

Puppeteer, PuppeteerSharp, Playwright (Node.js / Python / .NET), raw CDP, Go (chromedp / rod), Java (native WebSocket), and Ruby (Ferrum) all work without code rewrites. Swap wss://cloud.bots.win as your endpoint and pass your token, proxy, and device type as query parameters.

import puppeteer from "puppeteer-core";

const params = new URLSearchParams({
  token: process.env.BOTCLOUD_TOKEN,
  "--proxy-server": process.env.BOTCLOUD_PROXY,
  device_type: "mac",
});

const browser = await puppeteer.connect({
  browserWSEndpoint: `wss://cloud.bots.win?${params.toString()}`,
});

const page = await browser.newPage();
await page.goto("https://example.com");
await page.screenshot({ path: "screenshot.png" });
await browser.close();

Abrechnungsmodell

Abonnementpläne beinhalten monatliche Browser-Stunden. Nach deren Verbrauch wird die zusätzliche Nutzung aus Ihrem vorausbezahlten Guthaben zum Overage-Tarif des Plans abgerechnet.

Verbindungsfehler

Diese Fehler treten während des Verbindungsaufbaus auf — die Sitzung wird nie erstellt und erscheint daher nicht in /api/history. Prüfen Sie den HTTP-Status und die Meldung im Response-Body, um damit umzugehen.

Disconnect-Gründe

Sobald eine Sitzung geöffnet wurde, endet sie irgendwann mit einem der unten aufgeführten Gründe — aufgezeichnet in /api/history. Verwenden Sie diese Codes für die Fehlerbehandlung und Prüfpfade.