API दस्तऐवज

सर्व API विनंत्या HTTPS द्वारे केल्या पाहिजेत आणि खालील ओळखपत्रांसह HTTP बेसिक ऑथ वापरले पाहिजे:

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 विनंतीमध्ये डेटा पाठवा

यशस्वीरतेच्या बाबतीत, तुम्हाला 302 (पुनर्निर्देशन) दर्जासह http प्रतिसाद मिळेल आणि 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 पद्धती

पद्धत	इनपुट	आउटपुट
पीडीएफ / तयार करा	URL / HTML	HTML
html / तयार करा	URL / HTML	पीडीएफ

पॅरामीटर्स

तुम्हाला page_url किंवा html पॅरामिटर प्रदान करणे आवश्यक आहे. सर्व इतर पॅरामिटर्स पर्यायी आहेत.

पॅरामीटर्स	मूल्य
पृष्ठ URL	लक्ष्य पृष्ठाचा URL
HTML	लक्ष्य पृष्ठाचे HTML सामग्री
css_url	कस्टम CSS फाइलसाठी URL
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'

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 प्रतिसाद मिळेल ज्यामध्ये स्थिती २०० आणि प्रतिसाद बॉडीमध्ये PDF/HTML सामग्री असेल.

चुका

PrintFriendly चूक तपशील प्रदान करण्यासाठी पारंपारिक स्थिती कोडे आणि JSON प्रतिसाद वापरतो.

स्थिती कोड

स्थिती	वर्णन
२०० ठीक	सर्वकाही व्यवस्थित कार्य करते.
४०० चुकीची विनंती	चूक झाली आहे. JSON मध्ये तपशील पहा.
४०१ अनधिकृत	४०१ अनधिकृत
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

मोफत प्रारंभ करा

याचा विनामूल्य वापर करून पहा आणि क्रेडिट कार्ड आवश्यक नाही. काही प्रश्न असल्यास आम्हाला संपर्क साधा.