Dokumentácia API

Máte otázku? Kontaktujte nás.

Všetky požiadavky na API musia byť vykonané prostredníctvom HTTPS a vyžadujú api_key ako parameter dotazu URL.

Príklad

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

V prípade úspechu, dostanete http odpoveď so stavom 200 a JSON informácie v tele odpovede.

{"status":"success","file_url":"https://api.printfriendly.com/downloads/pdf_1531957353_e94df5Letter.pdf"}

Verzia rozhrania API

Aktuálna verzia API je 2.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	PDF

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
Typ výstupu	Nastavte na „attachment“, aby ste dostali PDF súbor ako výstup namiesto JSON
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/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 vstup

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>'

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 Stav 200) odpovede majú JSON telo s detailmi chyby a 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/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 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

Začnite zadarmo

Vyskúšajte to zadarmo a nie je potrebná kreditná karta. Kontaktujte nás s akýmikoľvek otázkami.