mirror of https://github.com/snapotter-hq/SnapOtter.git synced 2026-08-03 07:46:42 +02:00

Files

T

SnapOtterandGitHub 4963ab3bbd feat(docs-i18n): translate all documentation into 20 languages

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.

2026-07-11 13:52:47 +08:00

3.4 KiB

Raw Blame History

description, i18n_source_hash, i18n_provenance, i18n_output_hash

description	i18n_source_hash	i18n_provenance	i18n_output_hash
Leg webpagina's of HTML-fragmenten vast als hoogwaardige afbeeldingen met apparaatemulatie.	1e49d070ea2e	human	503b8212e274

HTML naar afbeelding

Leg een webpagina-URL of ruwe HTML-inhoud vast als een schermafbeelding. Ondersteunt apparaatemulatie (desktop, tablet, mobiel), vastlegging van de volledige pagina en meerdere uitvoerformaten.

API Endpoint

POST /api/v1/tools/image/html-to-image

Accepteert een JSON-body (geen multipart). Er is geen bestandsupload nodig.

Parameters

Parameter	Type	Vereist	Standaard	Beschrijving
url	string	Voorwaardelijk	-	URL om vast te leggen (moet een geldige URL zijn)
html	string	Voorwaardelijk	-	Ruwe HTML-inhoud om te renderen (1 tot 5.000.000 tekens)
format	string	Nee	`"png"`	Uitvoerformaat: `jpg`, `png`, `webp`
quality	number	Nee	`90`	Uitvoerkwaliteit voor lossy formaten (1 tot 100)
fullPage	boolean	Nee	`false`	Leg de volledige scrollbare pagina vast, niet alleen de viewport
devicePreset	string	Nee	`"desktop"`	Apparaatemulatie: `desktop`, `tablet`, `mobile`, `custom`
viewportWidth	number	Nee	`1280`	Aangepaste viewport-breedte in pixels (320 tot 3840, gebruikt wanneer devicePreset `custom` is)
viewportHeight	number	Nee	`720`	Aangepaste viewport-hoogte in pixels (320 tot 2160, gebruikt wanneer devicePreset `custom` is)

Ofwel url ofwel html moet worden opgegeven, maar niet beide.

Apparaat-presets

Preset	Breedte	Hoogte	Mobiele UA
`desktop`	1280	720	Nee
`tablet`	768	1024	Nee
`mobile`	375	812	Ja
`custom`	(door gebruiker opgegeven)	(door gebruiker opgegeven)	Nee

Voorbeeldverzoek

Een webpagina vastleggen:

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-inhoud renderen:

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"}'

Voorbeeldantwoord

{
  "jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/screenshot.png",
  "originalSize": 0,
  "processedSize": 145000
}

Opmerkingen

Vereist dat Chromium op de server is geïnstalleerd. Retourneert HTTP 503 als de browserservice niet beschikbaar is.
URL's worden gevalideerd tegen SSRF-aanvallen (privé/interne netwerkadressen worden geblokkeerd).
Dit endpoint is beperkt tot 120 verzoeken per uur.
originalSize is altijd 0, aangezien dit hulpmiddel afbeeldingen genereert vanuit URL's/HTML.
De uitvoerbestandsnaam is screenshot.<format>.
Als de pagina te lang duurt om te laden, retourneert het verzoek HTTP 504 (gateway timeout).
Als de browserservice herhaaldelijk crasht, wordt deze tijdelijk uitgeschakeld en retourneert HTTP 503 met code BROWSER_CRASHED.

3.4 KiB Raw Blame History