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

सफलता के मामले में, आपको स्थिति 200 और प्रतिक्रिया बॉडी में JSON जानकारी के साथ http प्रतिक्रिया मिलेगी।

{"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 विधियाँ

विधि	इनपुट	आउटपुट
पीडीएफ / बनाएँ	URL / HTML	HTML
html / बनाएँ	URL / HTML	पीडीएफ

पैरामीटर्स

आपको page_url या html पैरामीटर प्रदान करना होगा। सभी अन्य पैरामीटर वैकल्पिक हैं।

पैरामीटर्स	मूल्य
पृष्ठ URL	लक्षित पृष्ठ का URL
HTML	लक्षित पृष्ठ की HTML सामग्री
आउटपुट प्रकार	इसे "अटैचमेंट" पर सेट करें ताकि JSON के बजाय PDF फ़ाइल को आउटपुट के रूप में प्राप्त किया जा सके
css_url	कस्टम CSS फ़ाइल के लिए URL
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 में विवरण देखें।
४०१ अनधिकृत	४०१ अनधिकृत
404 नहीं मिला	404 नहीं मिला
429 बहुत अधिक अनुरोध	429 बहुत अधिक अनुरोध

सभी असफल (स्टेटस 200 नहीं) प्रतिक्रियाओं में त्रुटि विवरण के साथ JSON शरीर होता है और त्रुटि प्रकार और संदेश शामिल होते हैं।

त्रुटि प्रकार

प्रकार	विवरण
पैरामीटर सत्यापन	पैरामीटर मान्यता विफल रही।
प्रतिबंधित डोमेन	यह डोमेन अस्थायी रूप से प्रतिबंधित है।
पार्स विफल	पृष्ठ को पार्स नहीं कर सकते। हम इस पृष्ठ की सामग्री निर्धारित नहीं कर सकते।
फ़ेच त्रुटि	पृष्ठ प्राप्त नहीं किया जा सकता। जांचें कि URL सुलभ है और पुनः प्रयास करें।
उच्च भार	पैरामीटर का सत्यापन विफल हुआ।
अमान्य फ़ाइल एक्सटेंशन	केवल वेबपृष्ठों का समर्थन किया जाता है। यह एक PDF/TXT फ़ाइल या छवि (JPG, PNG, GIF) है।
बड़ा पृष्ठ	लक्षित पृष्ठ 2MB से बड़ा है। बड़े पृष्ठ समर्थित नहीं हैं।
सुरक्षा प्लेटफ़ॉर्म	सुरक्षा प्लेटफॉर्म हमें इस पेज को प्राप्त करने से रोकता है।
समय समाप्त	समय समाप्त। इंजन 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"}

अनुरोध दर सीमित करना

एपीआई में प्रति मिनट 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

मुफ्त में आरंभ करें

इसे मुफ्त आज़माएँ और क्रेडिट कार्ड की आवश्यकता नहीं है। यदि कोई प्रश्न हो तो हमसे संपर्क करें।