API Website Screenshot

ÜberblickLink to Überblick

Die Screenshot API von Piloterr rendert eine Webseite wie ein echter Browser und liefert einen Screenshot (PNG/JPEG/WebP) oder ein PDF zurück.
Sie ist für Abläufe gedacht, in denen du ein zuverlässiges visuelles Ergebnis für Previews, Reporting, QA, Monitoring und Archivierung brauchst, ohne eigene Headless-Browser-Infrastruktur aufzubauen.

Typische AnwendungsfälleLink to Typische Anwendungsfälle

• Website-Previews & Thumbnails: konsistente Vorschauen für Links in Dashboards, Verzeichnissen oder SEO-Tools erzeugen.
• QA & visuelle Regression: Seiten über Releases hinweg (Desktop/Mobile) erfassen, um UI-Änderungen zu erkennen.
• Reporting & Kunden-Deliverables: Full-Page-Screenshots oder PDFs für Audits und Dokumentation exportieren.
• Monitoring & Compliance: visuellen Nachweis des Seitenzustands zu einem bestimmten Zeitpunkt speichern (Preisseiten, rechtliche Seiten, Ads).
• Produkt- / Seiten-Capture: saubere Produktscreenshots erstellen, indem Cookie-Banner/Ads/Popups entfernt werden.
• Komponenten-Capture: ein spezifisches Element (Card, Widget, Chart) statt der ganzen Seite screenshotten.

SchnellstartLink to Schnellstart

Sende eine Anfrage mit url und deinem x-api-key. Der Response-Body ist die generierte Datei (binär).

Beispiel-Request:

curl -L "https://api.piloterr.com/v2/capture?x-api-key=YOUR_KEY&url=https://example.com" --output capture.png

Häufige Varianten:

Full Page

curl -L "https://api.piloterr.com/v2/capture?x-api-key=YOUR_KEY&url=https://example.com&full_page=true" --output full.png

Mobile Preview

curl -L "https://api.piloterr.com/v2/capture?x-api-key=YOUR_KEY&url=https://example.com&device=iphone_14_pro" --output mobile.png

PDF-Export

curl -L "https://api.piloterr.com/v2/capture?x-api-key=YOUR_KEY&url=https://example.com&format=pdf&full_page=true" --output page.pdf

ParameterLink to Parameter

ErforderlichLink to Erforderlich

• url (string): URL der Webseite, die gerendert und erfasst werden soll.

• x-api-key (string): API-Key (kann als Query-Param, Header x-api-key oder im Request-Body übergeben werden).

AusgabeLink to Ausgabe

• format (optional): Ausgabedateityp (png standardmäßig; unterstützt auch webp, jpeg/jpg, pdf).
• viewport_width / viewport_height (optional): Steuert die Desktop-Viewport-Größe.
• scale_factor (optional): Erhöht die Pixeldichte für schärfere Ergebnisse.
• image_quality (optional): Kompressionsqualität für webp / jpeg.

Mobile / Responsive TestingLink to Mobile / Responsive Testing

• device (optional): Emuliert ein vordefiniertes Mobile-/Tablet-Device-Profil.

Full-Page-CaptureLink to Full-Page-Capture

• full_page (optional): Erfasst die gesamte Seitenhöhe.
• full_page_scroll / full_page_scroll_duration (optional): Scrollt, um Lazy-Loaded-Content während Full-Page-Captures zu triggern.

Timing (JS-lastige Seiten)Link to Timing (JS-lastige Seiten)

• wait_for_selector (optional): Wartet, bis ein CSS-Selector existiert, bevor erfasst wird (ideal für SPAs).
• wait_until (optional): Wählt das „Ready“-Event der Seite.
• delay (optional): Feste Wartezeit vor der Aufnahme.

Cleanup (Overlays entfernen)Link to Cleanup (Overlays entfernen)

• remove_cookie_banners (optional): Versucht, Cookie-Banner zu entfernen.
• remove_ads (optional): Versucht, Werbung zu entfernen.
• remove_selectors (optional): Entfernt bestimmte Elemente über CSS-Selektoren.
• selector (optional): Erfasst nur ein bestimmtes Element.

Performance / RoutingLink to Performance / Routing

• block_urls (optional): Blockiert passende URL-Patterns (Tracker, Analytics).
• block_resources (optional): Blockiert Resource-Typen (Bilder, Fonts etc.).
• proxy (optional): Routing über einen Proxy (Geo-/Restricted-/Anti-Bot-Fälle).

CachingLink to Caching

• cache (optional): Cacht Ergebnisse für wiederholte Requests.
• cache_ttl (optional): Cache-TTL in Sekunden.

Storage (optional)Link to Storage (optional)

• S3-Upload: s3_url + Bucket/Credentials-Felder, um direkt zu S3 oder S3-kompatiblem Storage hochzuladen.

Hinweise / LimitsLink to Hinweise / Limits

• Seitenvariabilität: dynamische Seiten können sich zwischen Captures ändern; speichere Timestamps mit deinen Outputs.
• SPAs brauchen deterministische Waits: bevorzuge wait_for_selector für konsistente Ergebnisse auf JS-lastigen Seiten.
• Full Page + Infinite Scroll: Seiten mit endlosem Content können unvorhersehbare Full-Page-Renders erzeugen.
• Cleanup ist nicht universell: Cookie-Banner/Ads variieren je nach Seite; remove_selectors ist der zuverlässigste Fallback.
• Performance-Trade-offs: höherer scale_factor und Full-Page-Captures erhöhen Output-Größe und Render-Zeit.
• Binäre Response-Handhabung: Responses als Binärdaten behandeln (Blob/ArrayBuffer) im Playground/Client.