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 സ്റ്റാറ്റസ് ഉള്ള http പ്രതികരണം ലഭിക്കും, 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 പ്രവര്‍ത്തനരീതികള്‍

മേഖല

ഇൻപുട്ട്

ഔട്ട്‌പുട്ട്

പി‌ഡി‌എഫ് / സൃഷ്ടിക്കുക

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 ൽ വിശദാംശങ്ങൾ കാണുക.

401 അനുമതി ഇല്ലാത്തത്

401 അനുമതി ഇല്ലാത്തത്

404 കണ്ടെത്തിയില്ല

404 കണ്ടെത്തിയില്ല

429 അനവധി അഭ്യർത്ഥനകൾ

429 അനവധി അഭ്യർത്ഥനകൾ

എല്ലാ വിജയം കണ്ടില്ല (സ്ഥിതി 200 അല്ല) പ്രതികരണങ്ങള് JSON ബോഡിയിൽ പിശക് വിശദാംശങ്ങളും പിശക് തരവും സന്ദേശവും ഉൾക്കൊള്ളുന്നു.

പിശക് തരം

വര.group

വിവരണം

പരാമീറ്ററുകൾ വിലയിരുത്തൽ

പാരാമീറ്റർസ് സാങ്കൽപ്പികീകരണം പരാജയപ്പെട്ടു.

നിരോധിച്ച ഡൊമെയ്ൻ

ഈ ഡൊമെയിൻ താൽക്കാലികമായി നിരോധിച്ചു.

നിവർത്തിക്കലിൽ പരാജയം

പേജ് പാഴ്സ് ചെയ്യാൻ കഴിയില്ല. ഈ പേജിന്റെ ഉള്ളടക്കം നിർണയിക്കാൻ ഞങ്ങൾക്ക് കഴിയില്ല.

ഫെച്ചിംഗ് പിഴവ്

പേജ് കൊണ്ടുവരാൻ സാധിക്കില്ല. 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"}

അഭ്യർത്ഥനകളുടെ നിരക്ക് പരിധി

API 60 അഭ്യർഥനകൾക്ക് ഓരോ മിനിറ്റിലും പരിധിയുണ്ട്. നിങ്ങൾ ഈ പരിധിയെ മറികടന്നാൽ, സ്റ്റീറ്റസ്: 429 ഏറെ അഭ്യർഥനകൾ അടങ്ങുന്ന ഒരു പ്രതികരണം നിങ്ങൾക്ക് ലഭിക്കും.

ഹെഡർ

വിവരണം

എക്സ്സ്-റേറ്റ് പ്രസ്വാധം പരിധി

നിലവেলার കാലയളവിൽ മൊത്തം അഭ്യർത്ഥനകൾ പരിധി.

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

സൗജന്യമായി ആരംഭിക്കുക

ഇത് സൗജന്യമായി പരീക്ഷിക്കുക, ക്രഡിറ്റ് കാർഡ് ആവശ്യമാണ്. ഏതെങ്കിലും ചോദ്യങ്ങൾ ഉണ്ടെങ്കിൽ ഞങ്ങളെ ബന്ധപ്പെടുക.