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 | ಗುರಿ ಪೇಜಿನ 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 ಪ್ರತಿಕ್ರಿಯೆಯನ್ನು ಬಳಸುತ್ತದೆ.
ಸ್ಥಿತಿ ಕೋಡ್ಗಳು
ಸ್ಥಿತಿ | ವಿವರಣೆ |
|---|---|
೨೦೦ ಸರಿಯಾಗಿದೆ | ಎಲ್ಲವೂ ಸರಿಯಾಗಿ ಕೆಲಸ ಮಾಡುತ್ತಿದೆ. |
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