URL aufrufen
https://api.html2pdf.solutions/html2pdf/?parameter1=x¶meter2=y etc.
Konkretes Beispiel:
Dies generiert ein PDF der Google Startseite, welches mit dem Passwort 1234 geöffnet werden kann und die Dokumentenbezeichnung "Hallo Welt" lautet. Die zwei letzten Parameter sind optional und dienen hier nun als Beispiel.
Vergessen Sie nicht, das URL Encoding, sofern Sie url_to_render mit querystring verwenden!
Wenn Sie vergessen, die URL zu encoden, haben nicht alle Parameter eine Wirkung.
Erforderliche Parameter
Parameter | Typ | Beispiel | Beschreibung |
---|---|---|---|
UrlToRender | String | http://www.google.com | eine gültige absolute URL zu einer HTML-Seite |
Html | String | hello%20world | Alternativ: HTML-Quelltext, wenn Sie Ihr HTML dynamisch generieren und das Template nicht per URL zur Verfügung stellen wollen. In diesem Fall können Sie eine POST-Anfrage anstelle einer GET-Anfrage verwenden, wenn die Zeichenkette lang ist. POST-Anfragen sind nur in Verbindung mit dem Parameter Html sinnvoll. |
Optionale Parameter
Parameter | Typ | Beispiel | Beschreibung |
---|---|---|---|
HttpUsername | String | user | Wenn Ihre Seite nur mit Benutzername/Passwort erreichbar ist (HTTP Authentication/Basic Authentication). Dieser Wert muss alphanumerisch sein. |
HttpPassword | String | test | Wenn Ihre Seite nur mit Benutzername/Passwort erreichbar ist (HTTP Authentication/Basic Authentication). Beachten Sie, dass hier nicht alle Sonderzeichen erlaubt sind. Bitte nehmen Sie Kontakt mit uns auf, wenn Sie Hilfe benötigen. |
UserPassword | String | test | Wenn Sie Ihr PDF mit einem Passwort schützen wollen. |
UsePrintMediaType | Integer | 0, 1 | Standard: 0 Wenn Sie den Print Media Type verwenden wollen, setzen Sie den Wert auf 1 |
PrintBackground | Integer | 0, 1 | Standard: 1 Wenn Sie den Hintergrund NICHT drucken wollen, setzen Sie den Wert auf 0 |
HeaderText | String | <span class="title"></span> | Text, der über dem gerenderten Bildschirm angezeigt werden soll.Text, der über dem gerenderten Bildschirm angezeigt werden soll. Siehe auch FooterText-Parameter für weitere Variablen/Klassen. |
FooterText | String | <span class="title"></span> - <span class="url"></span> - <span class="date"></span> - Page <span class="pageNumber"></span>/<span class="totalPages"></span> | Funktioniert nur mit der kostenpflichtigen Version. |
FooterTemplateUrl | http%3A%2F%2Fwww.xy.com (encoded URL) | Die FooterTemplateUrl sollte einfach eine Seite sein, die die gewünschten Elemente enthält, die Sie in der Fußzeile anzeigen möchten. Wenn Sie die Grösse, Position von etwas, usw. ändern möchten, ändere Sie einfach Ihre Fußzeilenvorlage. Die URL muss eine HTML-Vorlage enthalten, die beispielsweise ein Bild und einen in HTML/CSS eingebetteten Text enthalten kann. Das Ziel der URL muss eine HTML-Seite und kein Bild sein. So können Sie Ihre Elemente beliebig positionieren und den bereitgestellten Kopfbereich nutzen. | |
FooterInsetHorizontal | Integer | 0, 14,100 | 14 ist der Default-Wert. 0: Die Fußzeile wird maximal links ausgerichtet. |
HeaderTemplateUrl | URL | http%3A%2F%2Fwww.xy.com (encoded URL) | Die HeaderTemplateUrl sollte einfach eine Seite sein, die die gewünschten Elemente enthält, die Sie im Header anzeigen möchten. Wenn Sie die Größe, Position oder ähnliches ändern möchten, ändern Sie einfach Ihre Kopfvorlage. Die URL muss eine HTML-Vorlage enthalten, die beispielsweise ein Bild und einen in HTML/CSS eingebetteten Text enthalten kann. Das Ziel der URL muss eine HTML-Seite und kein Bild sein. So können Sie Ihre Elemente beliebig positionieren und den bereitgestellten Fußbereich nutzen. |
InsetHorizontal | Integer | 20 | Linker und rechter Rand |
InsetVertical | Integer | 40 | Oberer und unterer Rand |
ContentDisposition | String | valid values: "attachment", "inline" | attachment ist der Default-Wert. Lädt das PDF/JPG herunter. |
Size | String | A0, A1, A2, A3, A4, A5, A6,Ledger,Tabloid,Legal,Letter | A4 ist der Default-Wert |
Orientation | String | portrait, landscape | |
FileName | String | somefilename | ändert den Standardwert für den Namen der PDF-Datei. |
Title | String | "Ihr Titel" (Vergessen Sie nicht die URL zu endcoden) | ändert den Standardwert für den PDF-Titel, der sich in den PDF-Eigenschaften befindet. |
Author | String | "John Smith" (Vergessen Sie nicht die URL zu endcoden) | ändert den Standardwert für den PDF-Autor, der sich in den PDF-Eigenschaften befindet. |
Subject | String | "Your Subject" (Vergessen Sie nicht die URL zu endcoden) | ändert den Standardwert für den PDF-Betreff, der sich in den PDF-Eigenschaften befindet. |
Zoom | Float | 0.75 (default), 0.5, 1, 1.5 | Zoom in and out |
MaxNrOfPages | Integer | 1 | Begrenzt die Anzahl der Seiten im PDF. |
Format | String | jpg | pdf (default) oder jpg |