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 పద్ధతులు
విధానం | ఇన్పుట్ | అవుట్పుట్ |
|---|---|---|
PDF / సృష్టించు | 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'
విజయం సాధించిన పక్షంలో, మీరు 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>'
విజయం జరిగిన 경우, మీరు స్థితి 200ని కలిగిన HTTP ప్రతిస్పందనను మరియు ప్రతిస్పందన శరీరంలో 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-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