Τεκμηρίωση API
Έχετε κάποια ερώτηση; Επικοινωνήστε μαζί μας.
Όλα τα αιτήματα API πρέπει να γίνονται μέσω HTTPS και χρειάζονται το api_key ως παράμετρο ερωτήματος URL.
Παράδειγμα
curl https://api.printfriendly.com/v2/pdf/create?api_key=YOUR_API_KEY /
-H 'Content-Type: application/x-www-form-urlencoded; charset=utf-8' /
-d page_url=https://en.wikipedia.org/wiki/Eclipse
Σε περίπτωση επιτυχίας, θα λάβετε μια http απάντηση με Κατάσταση 200 και πληροφορίες JSON στο σώμα της απάντησης.
{"status":"success","file_url":"https://api.printfriendly.com/downloads/pdf_1531957353_e94df5Letter.pdf"}
Έκδοση API
Η τρέχουσα έκδοση του API είναι 2.0.
Η κύρια έκδοση API πρέπει να παρέχεται στη διεύθυνση URL ως 'v' και αριθμός, π.χ. v1, v2, v3.
Παράδειγμα
https://api.printfriendly.com/v2/pdf/create
https://api.printfriendly.com/v2/html/create
Μέθοδοι API
Μέθοδος | Είσοδος | Έξοδος |
|---|---|---|
PDF / δημιουργία | URL / HTML | HTML |
html / δημιουργία | URL / HTML |
Παράμετροι
Πρέπει να παρέχετε την παράμετρο page_url ή html. Όλες οι άλλες παράμετροι είναι προαιρετικές.
Παράμετροι | Αξία |
|---|---|
Διεύθυνση URL της σελίδας | Διεύθυνση URL της σελίδας στόχου |
HTML | Περιεχόμενο HTML της σελίδας στόχου |
Τύπος εξόδου | Ρυθμίστε το σε "συνημμένο" για να λάβετε το αρχείο PDF ως έξοδο αντί για JSON |
css_url | URL για προσαρμοσμένο αρχείο CSS |
header_image_url | Διεύθυνση URL για την προσαρμοσμένη εικόνα κεφαλίδας |
Κείμενο κεφαλίδας | Σειρά κειμένου |
Όλα τα παρακάτω παραδείγματα παρέχονται για τη μέθοδο "pdf/create" και λειτουργούν και για τη μέθοδο "html/create".
Παράδειγμα με τη μεταβλητή page_url
curl https://api.printfriendly.com/v2/pdf/create?api_key=YOUR_API_KEY /
-H 'Content-Type: application/x-www-form-urlencoded; charset=utf-8' /
-d page_url=https://test.test /
-d css_url=https://my-site.com/pdf_style.css /
-d header_text='My Custom Header'
HTML εισαγωγή
curl https://api.printfriendly.com/v2/pdf/create?api_key=YOUR_API_KEY /
-H 'Content-Type: application/x-www-form-urlencoded; charset=utf-8' /
-d html='<html><body><h1>Title</h1><p>Text text text text text text text text text</p></body></html>'
Σφάλματα
Το PrintFriendly χρησιμοποιεί συμβατικούς κωδικούς κατάστασης και απάντηση JSON για την παροχή λεπτομερειών σφάλματος.
Κωδικοί κατάστασης
Κατάσταση | Περιγραφή |
|---|---|
200 Εντάξει | Όλα λειτουργούν σωστά. |
400 Μη έγκυρη αίτηση | Παρουσιάστηκε σφάλμα. Δείτε λεπτομέρειες στο JSON. |
401 Μη εξουσιοδοτημένο | 401 Μη εξουσιοδοτημένο |
404 Δεν βρέθηκε | 404 Δεν βρέθηκε |
429 Πάρα πολλά αιτήματα | 429 Πάρα πολλά αιτήματα |
Όλες οι μη επιτυχείς (όχι Κατάσταση 200) αποκρίσεις έχουν σώμα JSON με λεπτομέρειες σφάλματος και περιέχουν τον τύπο σφάλματος και το μήνυμα.
Τύποι σφαλμάτων
Τύπος | Περιγραφή |
|---|---|
Επικύρωση παραμέτρων | Η επικύρωση των παραμέτρων απέτυχε. |
Απαγορευμένος τομέας | Αυτός ο τομέας είναι προσωρινά αποκλεισμένος. |
Αποτυχία ανάλυσης | Δεν είναι δυνατή η ανάλυση σελίδας. Δεν μπορούμε να προσδιορίσουμε το περιεχόμενο αυτής της σελίδας. |
Σφάλμα λήψης | Δεν είναι δυνατή η λήψη της σελίδας. Ελέγξτε ότι η διεύθυνση URL είναι προσβάσιμη και δοκιμάστε ξανά. |
υψηλό φορτίο | Η επικύρωση παραμέτρων απέτυχε. |
Μη έγκυρη επέκταση αρχείου | Υποστηρίζονται μόνο ιστοσελίδες. Είναι αρχείο PDF/TXT ή εικόνα (JPG, PNG, GIF). |
μεγάλη σελίδα | Η σελίδα στόχος είναι πάνω από 2 MB. Οι μεγάλες σελίδες δεν υποστηρίζονται. |
πλατφόρμα ασφαλείας | Η πλατφόρμα ασφαλείας μας αποτρέπει από τη φόρτωση αυτής της σελίδας. |
λήξη χρονικού ορίου | Χρονική υπέρβαση. Η μηχανή δεν μπορεί να επεξεργαστεί τη σελίδα μέσα σε 30 δευτερόλεπτα. Παρακαλώ δοκιμάστε ξανά αργότερα. |
όλα | Απρόοπτο σφάλμα. Παρακαλώ δοκιμάστε ξανά αργότερα. |
Παράδειγμα
curl https://api.printfriendly.com/v2/pdf/create?api_key=YOUR_API_KEY /
-H 'Content-Type: application/x-www-form-urlencoded; charset=utf-8' /
-d page_url=https://test.test
HTML εισαγωγή
# 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"}
Περιορισμός ταχύτητας αιτημάτων
Το API έχει όριο 60 αιτημάτων ανά λεπτό. Εάν υπερβείτε αυτό το όριο, θα λάβετε μια απάντηση με Κατάσταση: 429 Πάρα πολλά αιτήματα.
Κεφαλίδα | Περιγραφή |
|---|---|
X-Όριο Ρυθμού | Συνολικό όριο αιτήσεων για την τρέχουσα περίοδο. |
X-Υπόλοιπο όριο | Απομένουσα αίτηση για την τρέχουσα περίοδο. |
Επαναφορά X-RateLimit | Πλήθος δευτερολέπτων μέχρι το τέλος της τρέχουσας περιόδου. |
Παράδειγμα με την παράμετρο page_url
# 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