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 অনুরোধে ডেটা প্রেরণ করুন |
সাফল্যের ক্ষেত্রে, আপনি 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 |
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'
সাফল্যের ক্ষেত্রে, আপনি 302 (স্থানান্তর) স্ট্যাটাস সহ একটি http প্রতিক্রিয়া পাবেন এবং 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 প্রতিক্রিয়া পাবেন স্টেটাস ২০০ এবং প্রতিক্রিয়া বডিতে PDF/HTML সামগ্রী সহ।
ত্রুটিসমূহ
PrintFriendly ত্রুটির বিশদ সরবরাহ করতে প্রচলিত স্ট্যাটাস কোড এবং JSON প্রতিক্রিয়া ব্যবহার করে।
স্ট্যাটাস কোড
অবস্থা | বিবরণ |
|---|---|
২০০ ঠিক আছে | সবকিছু ঠিকঠাক চলছে। |
৪০০ অনুরোধটি ব্যর্থ | একটি ত্রুটি ঘটেছে। JSON এ বিশদ দেখুন। |
৪০১ অনুমোদনহীন | ৪০১ অনুমোদনহীন |
৪০৪ পাওয়া যায়নি | ৪০৪ পাওয়া যায়নি |
৪২৯ অনুরোধ খুব বেশি | ৪২৯ অনুরোধ খুব বেশি |
সমস্ত অসফল (স্ট্যাটাস 302 OK নয়) প্রতিক্রিয়া JSON বডি সহ আসে যেখানে ত্রুটি বিশদ রয়েছে, যার মধ্যে ত্রুটির প্রকার এবং বার্তা অন্তর্ভুক্ত থাকবে।
ত্রুটি প্রকার
ধরণ | বিবরণ |
|---|---|
প্যারামিটার যাচাইকরণ | প্যারামিটার যাচাইকরণ ব্যর্থ হয়েছে। |
নিষিদ্ধ ডোমেইন | এই ডোমেনটি অস্থায়ীভাবে নিষিদ্ধ করা হয়েছে। |
পার্স করা ব্যর্থ | পাতাটি বিশ্লেষণ করতে পারছি না। আমরা এই পাতার বিষয়বস্তু নির্ধারণ করতে পারছি না। |
ফেচ ত্রুটি | পৃষ্ঠা আনতে পারছি না। নিশ্চিত করুন যে URLটি অ্যাক্সেসযোগ্য এবং আবার চেষ্টা করুন। |
উচ্চ-লোড | প্যারামিটার যাচাইকরণ ব্যর্থ হয়েছে। |
অবৈধ ফাইল এক্সটেনশন | শুধুমাত্র ওয়েবপেজ সমর্থিত। এটি একটি PDF/TXT ফাইল বা ছবি (JPG, PNG, GIF)। |
বড় পৃষ্ঠা | টার্গেট পৃষ্ঠাটি 2MB-এর বেশি। বড় পৃষ্ঠাগুলি সমর্থিত নয়। |
নিরাপত্তা প্ল্যাটফর্ম | নিরাপত্তা প্ল্যাটফর্ম এই পৃষ্ঠাটি আনতে বাধা দেয়। |
সময়শেষ | সময়সীমা শেষ হয়েছে। ইঞ্জিন ৩০ সেকেন্ডের মধ্যে পৃষ্ঠাটি প্রক্রিয়া করতে পারছে না। অনুগ্রহ করে পরে আবার চেষ্টা করুন। |
সবকিছুর জন্য | অপ্রত্যাশিত ত্রুটি। অনুগ্রহ করে পরে আবার চেষ্টা করুন। |
উদাহরণ
curl https://api.printfriendly.com/v1/pdfs/create /
-u your_api_key: /
-d page_url=https://test.test
HTML input
# 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"}
অনুরোধের হার সীমিতকরণ
এপিআই প্রতি মিনিটে ৬০টির অনুরোধের সীমা রয়েছে। আপনি যদি এই সীমা অতিক্রম করেন, তাহলে আপনি স্ট্যাটাস: ৪২৯ টু ম্যানি রিকোয়েস্টস সহ একটি প্রতিক্রিয়া পাবেন।
হেডার | বিবরণ |
|---|---|
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