API Documentation
May tanong ka ba? Makipag-ugnayan sa amin.
Ang lahat ng API na kahilingan ay kailangang gawin sa HTTPS at kailangang mayroong api_key bilang URL query parameter.
Halimbawa
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
Sa kaso ng tagumpay, makakakuha ka ng http na tugon na may Status 200 at JSON impormasyon sa tugon katawan.
{"status":"success","file_url":"https://api.printfriendly.com/downloads/pdf_1531957353_e94df5Letter.pdf"}
Bersyon ng API
Ang kasalukuyang bersyon ng API ay 2.0.
Ang pangunahing bersyon ng API ay kailangang ibigay sa URL bilang 'v' at numero, halimbawa, v1, v2, v3.
Halimbawa
https://api.printfriendly.com/v2/pdf/create
https://api.printfriendly.com/v2/html/create
Mga Paraan ng API
Pamamaraan | Input | Output |
|---|---|---|
PDF / gumawa | URL / HTML | HTML |
html / gumawa | URL / HTML |
Mga Parameter
Kailangan mong magbigay ng page_url o html na parameter. Ang lahat ng ibang mga parameter ay opsyonal.
Mga Parameter | Halaga |
|---|---|
URL ng pahina | URL ng target na page |
HTML | Nilalaman ng HTML ng target na pahina |
Uri ng output | I-set ito sa "attachment" para matanggap ang PDF file bilang output sa halip na JSON |
css_url | URL para sa Custom CSS file |
header_image_url | URL para sa Custom Header na imahe |
Teksto ng header | String ng Teksto |
Ang lahat ng mga halimbawa sa ibaba ay ibinigay para sa "pdf/create" na method at gumagana rin para sa "html/create" na method.
Halimbawa gamit ang parameter na 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'
Ipasok ang 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>'
Mga Error
Gumagamit ang PrintFriendly ng mga conventional status codes at JSON response para magbigay ng mga detalye ng error.
Mga Code ng Status
Katayuan | Paglalarawan |
|---|---|
200 OK | Lahat ay gumagana nang maayos. |
400 Maling Kahilingan | May naganap na error. Tingnan ang mga detalye sa JSON. |
401 Hindi Awtorisado | 401 Hindi Awtorisado |
404 Hindi Natagpuan | 404 Hindi Natagpuan |
429 Napakaraming Kahilingan | 429 Napakaraming Kahilingan |
Lahat ng hindi matagumpay (hindi Status 200) na tugon ay may JSON body na naglalaman ng mga detalye ng error at naglalaman ng uri at mensahe ng error.
Mga Uri ng Error
Uri | Paglalarawan |
|---|---|
Pagpapatunay ng mga Parameter | Nabigo ang pag-validate ng mga parameter. |
Pinagbawal na domain | Pansamantalang pinagbawalan ang domain na ito. |
Nabigong i-parse | Hindi ma-proseso ang pahina. Hindi namin matukoy ang nilalaman ng pahinang ito. |
Error sa pagkuha | Hindi makuha ang pahina. Tiyaking naa-access ang URL at subukang muli. |
mataas na pagkarga | Nabigo ang pag-validate ng mga parameter. |
Hindi wastong file extension | Mga webpage lang ang sinusuportahan. Isa itong PDF/TXT file o Larawan (JPG, PNG, GIF). |
malaking pahina | Ang target na pahina ay lampas sa 2Mb. Hindi sinusuportahan ang malalaking pahina. |
plataporma ng seguridad | Hinaharang ng seguridad na platform ang pagkuha ng pahinang ito. |
timeout | Lumagpas na ang timeout. Hindi ma-proseso ng engine ang page sa loob ng 30 segundo. Pakisubukan ulit mamaya. |
panlahat | Di-inaasahang error. Pakisubukang muli mamaya. |
Halimbawa
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
Ipasok ang 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"}
Paglilimita ng Bilis ng Mga Kahilingan
May limit ang API na 60 requests kada minuto. Kung lalampas ka sa limit na ito, makakatanggap ka ng response na may Status: 429 Too Many Requests.
Header | Paglalarawan |
|---|---|
X-Limitasyon sa Bilis | Kabuuang limit ng mga request para sa kasalukuyang period. |
X-RateLimit-Natira | Natitirang request para sa kasalukuyang period. |
I-reset ang X-RateLimit | Bilang ng mga segundo bago matapos ang kasalukuyang yugto. |
Halimbawa gamit ang page_url parameter
# 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