API-Dokumentation
Haben Sie eine Frage? Kontaktieren Sie uns.
Alle API-Anfragen müssen über HTTPS erfolgen und HTTP Basic Auth mit den folgenden Zugangsdaten verwenden:
Username: API KEY
Password: Not needed
Beispiel
curl https://api.printfriendly.com/v1/pdfs/create /
-u your_api_key: /
-d page_url=https://en.wikipedia.org/wiki/Eclipse
Flagge | Beschreibung |
|---|---|
-u | Geben Sie grundlegende Authentifizierungsdaten weiter, ein Doppelpunkt nach dem API-Schlüssel verhindert, dass cURL nach einem Passwort fragt. |
-d | Daten im POST-Anfrage senden |
Im Falle eines Erfolgs erhalten Sie eine HTTP-Antwort mit dem Status 302 (Weiterleitung) und die JSON-Informationen befinden sich im Antwortkörper.
# HTTP RESPONSE
# HEADERS (some of headers are ommited)
Content-Type: application/json; charset=utf-8
Status: 302 Found
Location: https://v.printfriendly.com/system/pdfs/pdf_1480936999_755625A4.pdf
# BODY
{"success":"Redirect to https://v.printfriendly.com/system/pdfs/pdf_1480947535_6e7ecaA4.pdf"}
API-Version
Die aktuelle Version der API ist 1.0.
Die Haupt-API-Version muss in der URL als 'v' und Nummer angegeben werden, z.B. v1, v2, v3.
Beispiel
https://api.printfriendly.com/v2/pdf/create
https://api.printfriendly.com/v2/html/create
API-Methoden
Methode | Eingabe | Ausgabe |
|---|---|---|
PDF / erstellen | URL / HTML | HTML |
html / erstellen | URL / HTML |
Parameter
Sie müssen den Parameter page_url oder html angeben. Alle anderen Parameter sind optional.
Parameter | Wert |
|---|---|
Seiten-URL | URL der Zielseite |
HTML | HTML-Inhalt der Zielseite |
css_url | URL für benutzerdefinierte CSS-Datei |
header_image_url | URL für benutzerdefiniertes Header-Bild |
Kopfzeilentext | Textzeichenkette |
Alle unten stehenden Beispiele werden für die Methode "pdf/create" bereitgestellt und funktionieren auch für die Methode "html/create".
Beispiel mit page_url-Parameter
curl https://api.printfriendly.com/v1/pdfs/create /
-u your_api_key: /
-d page_url=https://test.test /
-d css_url=https://my-site.com/pdf_style.css /
-d header_text='My Custom Header'
Im Falle eines Erfolgs erhalten Sie eine HTTP-Antwort mit dem Status 302 (Weiterleitung) und die JSON-Informationen befinden sich im Antwortkörper.
Beispiel mit html-Parametern
curl https://api.printfriendly.com/v1/pdfs/create /
-u your_api_key: /
-d html='<html><body><h1>Title</h1><p>Text text text text text text text text text</p></body></html>'
Im Falle eines Erfolgs erhalten Sie eine http-Antwort mit Status 200 und PDF-/HTML-Inhalt im Antwortkörper.
Fehler
PrintFriendly verwendet konventionelle Statuscodes und JSON-Antworten, um Fehlerdetails bereitzustellen.
Statuscodes
Status | Beschreibung |
|---|---|
200 OK | Alles funktioniert einwandfrei. |
400 Ungültige Anfrage | Ein Fehler ist aufgetreten. Details finden Sie in JSON. |
401 Nicht autorisiert | 401 Nicht autorisiert |
404 Nicht gefunden | 404 Nicht gefunden |
429 Zu viele Anfragen | 429 Zu viele Anfragen |
Alle nicht erfolgreichen (nicht Status 302 OK) Antworten haben einen JSON-Körper mit den Fehlerdetails, einschließlich Fehlertyp und Nachricht.
Fehlertypen
Typ | Beschreibung |
|---|---|
Parameter-Validierung | Validierung der Parameter fehlgeschlagen. |
Verbotene Domain | Diese Domain ist vorübergehend gesperrt. |
Parserfehler | Seite kann nicht analysiert werden. Wir können den Inhalt dieser Seite nicht bestimmen. |
Abruffehler | Seite kann nicht abgerufen werden. Überprüfen Sie, ob die URL zugänglich ist, und versuchen Sie es erneut. |
hohe Belastung | Die Validierung der Parameter ist fehlgeschlagen. |
Ungültige Dateierweiterung | Es werden nur Webseiten unterstützt. Es handelt sich um eine PDF/TXT-Datei oder ein Bild (JPG, PNG, GIF). |
große Seite | Die Zielseite ist über 2 MB groß. Große Seiten werden nicht unterstützt. |
Sicherheitsplattform | Die Sicherheitsplattform blockiert uns daran, diese Seite abzurufen. |
Zeitüberschreitung | Zeitüberschreitung. Die Engine kann die Seite innerhalb von 30 Sekunden nicht verarbeiten. Bitte versuchen Sie es später erneut. |
Allgemein | Unerwarteter Fehler. Bitte versuchen Sie es später noch einmal. |
Beispiel
curl https://api.printfriendly.com/v1/pdfs/create /
-u your_api_key: /
-d page_url=https://test.test
HTML-Eingabe
# HTTP RESPONSE
# HEADERS (some of headers were ommited)
Content-Type: application/json; charset=utf-8/
Status: 400 Bad Request
# BODY (JSON)
{"status":"failed","message":"Print technology unable to download or parse content"}
Begrenzung der Anfragehäufigkeit
Die API hat ein Limit von 60 Anfragen pro Minute. Wenn Sie dieses Limit überschreiten, erhalten Sie eine Antwort mit Status: 429 Zu viele Anfragen.
Kopfzeile | Beschreibung |
|---|---|
X-Rate-Limit-Begrenzung | Gesamtanfragegrenze für den aktuellen Zeitraum. |
X-RateLimit-Verbleibend | Verbleibende Anfrage für die aktuelle Periode. |
X-RateLimit zurücksetzen | Anzahl der Sekunden bis zum Ende der aktuellen Periode. |
Beispiel mit page_url-Parameter
# HEADERS (some of headers were ommited)
Status: 429 Too Many Requests
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 20
# BODY (JSON)Empty