תיעוד API

כל בקשות ה-API חייבות להתבצע דרך HTTPS ולהשתמש ב-HTTP Basic Auth עם האישורים הבאים:

Username: API KEY

Password: Not needed

דוגמה

curl https://api.printfriendly.com/v1/pdfs/create /

-u your_api_key: /

-d page_url=https://en.wikipedia.org/wiki/Eclipse

דגל	תיאור
-u	העבר אישורי אימות בסיסיים, נקודתיים אחרי מפתח ה-API מונעים מ-cURL לבקש סיסמה.
-ד	שלח נתונים בבקשת POST

במקרה של הצלחה, תקבלו תגובת http עם סטאטוס 302 (הפניה) והמידע של JSON יהיה בגוף התגובה.

# 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

הגרסה הנוכחית של ה-API היא 1.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	PDF

פרמטרים

עליך לספק פרמטר page_url או html. כל שאר הפרמטרים הם אופציונליים.

פרמטרים	ערך
כתובת עמוד	כתובת ה-URL של דף היעד
HTML	תוכן HTML של דף היעד
css_url	כתובת URL לקובץ CSS מותאם אישית
header_image_url	כתובת URL לתמונה מותאמת אישית בכותרת
טקסט כותרת	מחרוזת טקסט

כל הדוגמאות למטה מסופקות עבור השיטה "pdf/create" ועובדות גם עבור השיטה "html/create".

דוגמה עם פרמטר page_url

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'

במקרה של הצלחה, תקבלו תגובת http עם סטאטוס 302 (הפניה) והמידע של JSON יהיה בגוף התגובה.

דוגמה עם פרמטרים של html

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

במקרה של הצלחה, תקבל תגובת HTTP עם סטטוס 200 ותוכן PDF/HTML בגוף התגובה.

שגיאות

PrintFriendly משתמש בקודי סטטוס קונבנציונליים ובתגובת JSON כדי לספק פרטי שגיאה.

קודי מצב

סטטוס	תיאור
200 בסדר	הכל עובד בסדר.
400 בקשה שגויה	אירעה שגיאה. ראה פרטים ב-JSON.
401 לא מורשה	401 לא מורשה
404 לא נמצא	404 לא נמצא
429 יותר מדי בקשות	429 יותר מדי בקשות

כל התגובות שלא הצליחו (לא סטטוס 302 OK) כוללות גוף JSON עם פרטי השגיאה, שיכללו את סוג השגיאה וההודעה.

סוגי שגיאות

סוג	תיאור
אימות פרמטרים	אימות הפרמטרים נכשל.
תחום אסור	הדומיין הזה נחסם באופן זמני.
שגיאה בניתוח	לא ניתן לנתח את הדף. איננו יכולים לקבוע את התוכן של דף זה.
שגיאת אחזור	לא ניתן לאחזר את העמוד. בדוק שהכתובת URL נגישה ונסה שוב.
עומס גבוה	בדיקת הפרמטרים נכשלה.
סיומת קובץ לא חוקית	רק דפי אינטרנט נתמכים. זהו קובץ PDF/TXT או תמונה (JPG, PNG, GIF).
עמוד גדול	דף היעד גדול מ-2MB. דפים גדולים אינם נתמכים.
פלטפורמת אבטחה	הפלטפורמה האבטחתית חוסמת אותנו מלגשת לעמוד זה.
פסק זמן	פג זמן ההמתנה. המנוע אינו יכול לעבד את הדף בתוך 30 שניות. אנא נסה שנית מאוחר יותר.
הכולל	שגיאה לא צפויה. אנא נסה שוב מאוחר יותר.

דוגמה

curl https://api.printfriendly.com/v1/pdfs/create /

-u your_api_key: /

-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

התחל בחינם

נסו את זה בחינם ואין צורך בכרטיס אשראי. צרו קשר לאי אלו שאלות.