mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
SnapOtterandGitHub
4963ab3bbd
All 181 docs markdown files translated into 20 languages (apps/docs/<locale>/**). Companion to the i18n code PR; admin-merged because the file count exceeds GitHub's per-PR CI trigger limit. Validated by pnpm i18n:check (all surfaces, 0 stale/missing) and a clean all-locale docs build.
82 lines
3.4 KiB
Markdown
82 lines
3.4 KiB
Markdown
---
|
|
description: "Erfasst Webseiten oder HTML-Snippets als hochwertige Bilder mit Geräteemulation."
|
|
i18n_source_hash: 1e49d070ea2e
|
|
i18n_provenance: human
|
|
i18n_output_hash: b6deed9bc22c
|
|
---
|
|
|
|
# HTML zu Bild {#html-to-image}
|
|
|
|
Erfasst eine Webseiten-URL oder rohen HTML-Inhalt als Screenshot-Bild. Unterstützt Geräteemulation (Desktop, Tablet, Mobil), Erfassung der gesamten Seite und mehrere Ausgabeformate.
|
|
|
|
## API-Endpunkt {#api-endpoint}
|
|
|
|
`POST /api/v1/tools/image/html-to-image`
|
|
|
|
Akzeptiert einen **JSON-Body** (kein Multipart). Es ist kein Datei-Upload erforderlich.
|
|
|
|
## Parameter {#parameters}
|
|
|
|
| Parameter | Typ | Erforderlich | Standard | Beschreibung |
|
|
|-----------|------|----------|---------|-------------|
|
|
| url | string | Bedingt | - | Zu erfassende URL (muss eine gültige URL sein) |
|
|
| html | string | Bedingt | - | Zu rendernder roher HTML-Inhalt (1 bis 5.000.000 Zeichen) |
|
|
| format | string | Nein | `"png"` | Ausgabeformat: `jpg`, `png`, `webp` |
|
|
| quality | number | Nein | `90` | Ausgabequalität für verlustbehaftete Formate (1 bis 100) |
|
|
| fullPage | boolean | Nein | `false` | Die gesamte scrollbare Seite erfassen, nicht nur den sichtbaren Bereich |
|
|
| devicePreset | string | Nein | `"desktop"` | Geräteemulation: `desktop`, `tablet`, `mobile`, `custom` |
|
|
| viewportWidth | number | Nein | `1280` | Benutzerdefinierte Viewport-Breite in Pixeln (320 bis 3840, verwendet, wenn devicePreset `custom` ist) |
|
|
| viewportHeight | number | Nein | `720` | Benutzerdefinierte Viewport-Höhe in Pixeln (320 bis 2160, verwendet, wenn devicePreset `custom` ist) |
|
|
|
|
Entweder `url` oder `html` muss angegeben werden, aber nicht beides.
|
|
|
|
### Geräte-Voreinstellungen {#device-presets}
|
|
|
|
| Voreinstellung | Breite | Höhe | Mobile UA |
|
|
|--------|-------|--------|-----------|
|
|
| `desktop` | 1280 | 720 | Nein |
|
|
| `tablet` | 768 | 1024 | Nein |
|
|
| `mobile` | 375 | 812 | Ja |
|
|
| `custom` | (benutzerdefiniert) | (benutzerdefiniert) | Nein |
|
|
|
|
## Beispielanfrage {#example-request}
|
|
|
|
Eine Webseite erfassen:
|
|
|
|
```bash
|
|
curl -X POST http://localhost:1349/api/v1/tools/image/html-to-image \
|
|
-H "Authorization: Bearer si_your-api-key" \
|
|
-H "Content-Type: application/json" \
|
|
-d '{"url": "https://example.com", "format": "png", "fullPage": true, "devicePreset": "desktop"}'
|
|
```
|
|
|
|
HTML-Inhalt rendern:
|
|
|
|
```bash
|
|
curl -X POST http://localhost:1349/api/v1/tools/image/html-to-image \
|
|
-H "Authorization: Bearer si_your-api-key" \
|
|
-H "Content-Type: application/json" \
|
|
-d '{"html": "<div style=\"padding: 20px; background: #f0f0f0;\"><h1>Hello</h1></div>", "format": "png"}'
|
|
```
|
|
|
|
## Beispielantwort {#example-response}
|
|
|
|
```json
|
|
{
|
|
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
|
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/screenshot.png",
|
|
"originalSize": 0,
|
|
"processedSize": 145000
|
|
}
|
|
```
|
|
|
|
## Hinweise {#notes}
|
|
|
|
- Erfordert, dass Chromium auf dem Server installiert ist. Gibt HTTP 503 zurück, wenn der Browser-Dienst nicht verfügbar ist.
|
|
- URLs werden gegen SSRF-Angriffe validiert (private/interne Netzwerkadressen werden blockiert).
|
|
- Dieser Endpunkt ist auf 120 Anfragen pro Stunde begrenzt.
|
|
- `originalSize` ist immer 0, da dieses Werkzeug Bilder aus URLs/HTML generiert.
|
|
- Der Ausgabedateiname lautet `screenshot.<format>`.
|
|
- Wenn das Laden der Seite zu lange dauert, gibt die Anfrage HTTP 504 (Gateway-Timeout) zurück.
|
|
- Wenn der Browser-Dienst wiederholt abstürzt, wird er vorübergehend deaktiviert und gibt HTTP 503 mit dem Code `BROWSER_CRASHED` zurück.
|