Dokumentácia API
Máte otázku? Kontaktujte nás.
Všetky API požiadavky musia byť vykonané cez HTTPS a musia používať HTTP Basic Auth s nasledujúcimi povereniami:
Username: API KEY
Password: Not needed
Príklad
curl https://api.printfriendly.com/v1/pdfs/create /
-u your_api_key: /
-d page_url=https://en.wikipedia.org/wiki/Eclipse
Vlajka | Popis |
|---|---|
-u | Preneste základné prihlasovacie údaje, dvojbodka po kľúči API zabraňuje programu cURL žiadať heslo. |
-d | odoslať údaje v požiadavke POST |
V prípade úspechu dostanete HTTP odpoveď so stavom 302 (Presmerovanie) a informácie JSON budú v tele odpovede.
# 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"}
Verzia rozhrania API
Aktuálna verzia API je 1.0.
Hlavná verzia API musí byť uvedená v URL ako 'v' a číslo, napr. v1, v2, v3.
Príklad
https://api.printfriendly.com/v2/pdf/create
https://api.printfriendly.com/v2/html/create
Metódy API
Metóda | Vstup | Výstup |
|---|---|---|
PDF / vytvoriť | URL / HTML | HTML |
html / vytvoriť | URL / HTML |
Parametre
Musíte zadať parameter page_url alebo html. Všetky ostatné parametre sú voliteľné.
Parametre | Hodnota |
|---|---|
URL stránky | URL cieľovej stránky |
HTML | HTML obsah cieľovej stránky |
css_url | URL pre vlastný súbor CSS |
header_image_url | URL pre obrázok vlastného záhlavia |
Text záhlavia | Textový reťazec |
Všetky príklady uvedené nižšie sú určené pre metódu "pdf/create" a fungujú aj pre metódu "html/create".
Príklad s parametrom 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'
V prípade úspechu dostanete HTTP odpoveď so stavom 302 (Presmerovanie) a informácie JSON budú v tele odpovede.
Príklad s html parametrami
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>'
V prípade úspechu dostanete odpoveď HTTP so stavom 200 a obsahom PDF/HTML v tele odpovede.
Chyby
PrintFriendly používa konvenčné statusové kódy a odpovede JSON na poskytovanie podrobností o chybách.
Stavové kódy
Stav | Popis |
|---|---|
200 OK | Všetko funguje správne. |
400 Neplatná žiadosť | Došlo k chybe. Podrobnosti nájdete v JSON. |
401 Neoprávnené | 401 Neoprávnené |
404 Nenašlo sa | 404 Nenašlo sa |
429 Príliš veľa požiadaviek | 429 Príliš veľa požiadaviek |
Všetky neúspešné (nie Status 302 OK) odpovede majú JSON telo s informáciami o chybe, ktoré obsahujú typ chyby a správu.
Typy chýb
Typ | Popis |
|---|---|
Validácia parametrov | Overenie parametrov zlyhalo. |
Zakázaná doména | Táto doména je dočasne zakázaná. |
Chyba pri spracovaní | Nemožno analyzovať stránku. Nedokážeme určiť obsah tejto stránky. |
Chyba načítania | Nie je možné načítať stránku. Skontrolujte, či je URL prístupné, a skúste to znova. |
vysoké zaťaženie | Overenie parametrov zlyhalo. |
Neplatná prípona súboru | Podporované sú iba webové stránky. Ide o PDF/TXT súbor alebo obrázok (JPG, PNG, GIF). |
veľká stránka | Cieľová stránka má viac ako 2 MB. Veľké stránky nie sú podporované. |
bezpečnostná platforma | Bezpečnostná platforma nám blokuje načítanie tejto stránky. |
časový limit | Časový limit vypršal. Stroj nemôže spracovať stránku do 30 sekúnd. Skúste to prosím neskôr. |
všetko-zahŕňajúci | Neočakávaná chyba. Skúste to prosím neskôr znova. |
Príklad
curl https://api.printfriendly.com/v1/pdfs/create /
-u your_api_key: /
-d page_url=https://test.test
HTML vstup
# 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"}
Obmedzenie rýchlosti požiadaviek
API má limit 60 požiadaviek za minútu. Ak tento limit prekročíte, dostanete odpoveď so stavom: 429 Príliš veľa požiadaviek.
Hlavička | Popis |
|---|---|
X-Ohraničenie rýchlosti | Celkový limit požiadaviek na aktuálne obdobie. |
X-Zostávajúci limit | Zostávajúca žiadosť na aktuálne obdobie. |
Resetovať X-RateLimit | Počet sekúnd do konca aktuálneho obdobia. |
Príklad s parametrom 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