Zum Inhalt springen

Installation: SDKs und die rohe HTTP-Schnittstelle

Installiere das TypeScript- oder Python-SDK oder sprich die HTTP-API direkt an, und erfahre, was der Protokoll-Header für dich aushandelt.

Zuletzt aktualisiert:

Drei Oberflächen, eine API

Browserberg bietet eine HTTP-API und drei Arten, sie zu halten: das TypeScript-SDK, das Python-SDK und die rohen Endpunkte. Entscheide pro Team, nicht pro Projekt — das Wire-Format darunter ist identisch, ein aus Python veröffentlichter Workflow lässt sich also ohne Übersetzung aus TypeScript oder mit purem cURL inspizieren.

Die SDKs sind absichtlich dünn. Sie ergänzen Session-Handles, die sich selbst freigeben, Schema-Konvertierung für Extraktionen und typisierte Antworten; Verhalten, das die API nicht hat, fügen sie nicht hinzu. Alles, was diese Doku in einem SDK-Tab zeigt, lässt sich mit zwei, drei curl-Aufrufen nachstellen.

SDK installieren

Ein Paket pro Sprache, keine Peer-Dependencies, kein CLI-Setup.

npm install @browserberg/sdk

Hinweis · Noch nicht in den Registries

Die Pakete sind noch nicht auf npm oder PyPI veröffentlicht. Die Befehle oben zeigen den vorgesehenen Installationsweg; heute installierst du beide SDKs aus dem Repository-Checkout.

Voraussetzungen und Versionsverhandlung

Du brauchst Node 18 oder neuer für das TypeScript-SDK und Python 3.10 oder neuer für das Python-SDK. Beide exportieren das komplette Protokollvokabular weiter — jeden Request- und Response-Typ, jedes Enum — es gibt also keine zweite Typ-Abhängigkeit, die du synchron halten müsstest.

Jeder Request darf einen x-browserberg-protocol-Header tragen. Die Verhandlung ist bewusst eng: Major-Versionen müssen exakt übereinstimmen, und die Minor-Version des Servers muss mindestens deiner entsprechen. Praktisch heißt das: Ein älteres SDK funktioniert gegen einen neueren Server weiter, und eine Antwort kann Felder enthalten, die deine Version nie angefragt hat — die SDKs tolerieren sie, und dein Code sollte das auch. Ein Request mit einem vertippten Feld wird dagegen mit 400 abgelehnt statt still ignoriert.

Weiter geht es

  • Schnellstart Vom frischen Schlüssel zu extrahierten Daten in einer Datei
  • Authentifizierung Schlüssel anlegen und den Fehlerumschlag lesen
  • Sessions-Referenz Jedes Feld, das eine Session annimmt und zurückgibt