API dokumentáció

Van kérdése? Lépjen kapcsolatba velünk.

Minden API-kérést HTTPS-en keresztül kell végrehajtani, és szükséges hozzá api_key, mint URL-lekérdezési paraméter.

Példa

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

Siker esetén http válasz érkezik státusszal 200 és JSON információval a válasz testében.

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

API verzió

Az API aktuális verziója 2.0.

Az API fő verzióját az URL-ben 'v' és egy szám formájában kell megadni, például v1, v2, v3.

Példa

https://api.printfriendly.com/v2/pdf/create

https://api.printfriendly.com/v2/html/create

API metódusok

Módszer	Bemenet	Kimenet
PDF / létrehozás	URL / HTML	HTML
html / létrehozás	URL / HTML	PDF

Paraméterek

A page_url vagy html paraméter megadása kötelező. Minden más paraméter opciós.

Paraméterek	Érték
Oldal URL	Céloldal URL-je
HTML	Céloldal HTML tartalma
Kimeneti típus	Állítsd be "attachment"-re, hogy a PDF fájlt kapd meg kimenetként JSON helyett
css_url	URL az egyéni CSS fájlhoz
header_image_url	URL az egyéni fejléc képhez
Fejléc szöveg	Szöveges karakterlánc

Az alábbi példák mind a "pdf/create" módszerhez lettek megadva, és működnek a "html/create" módszerhez is.

Példa a page_url paraméterrel

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 bemenet

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

Hibák

A PrintFriendly hagyományos állapotkódokat és JSON válaszokat használ a hibák részleteinek bemutatására.

Állapotkódok

Állapot	Leírás
200 OK	Minden rendben működik.
400 Hibás kérelem	Hiba történt. Részletek a JSON-ben.
401 Jogosulatlan	401 Jogosulatlan
404 Nem található	404 Nem található
429 Túl sok kérés	429 Túl sok kérés

Minden sikertelen (nem Status 200) válasznak van JSON-törzse hibával kapcsolatos részletekkel, amely tartalmazza a hibátípus és az üzenetet.

Hibatípusok

Típus	Leírás
Paraméterek érvényesítése	Paraméterek érvényesítése sikertelen.
Betiltott domain	Ez a domain ideiglenesen le van tiltva.
Hiba a feldolgozásban	Nem sikerült elemezni az oldalt. Nem tudjuk meghatározni az oldal tartalmát.
Lekérési hiba	Nem sikerült betölteni az oldalt. Ellenőrizze, hogy az URL elérhető-e, és próbálja újra.
nagy terhelés	A paraméterek ellenőrzése sikertelen.
Érvénytelen fájlkiterjesztés	Csak weboldalak támogatottak. Ez egy PDF/TXT fájl vagy kép (JPG, PNG, GIF).
nagy oldal	A céloldal meghaladja a 2 MB-ot. A nagy oldalak nem támogatottak.
biztonsági platform	A biztonsági platform blokkolja a hozzáférést ehhez az oldalhoz.
időtúllépés	Időtúllépés történt. A motor nem tudja feldolgozni az oldalt 30 másodperc alatt. Kérjük, próbálja meg később újra.
mindenre kiterjedő	Váratlan hiba. Kérjük, próbálkozzon később.

Példa

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 bemenet

# 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"}

Kérelemsebesség korlátozása

Az API korlátja 60 kérés percenként. Ha túllépi ezt a korlátot, válasz érkezik az állapottal: 429 Túl sok kérés.

Fejléc	Leírás
X-Arány Korlát	A jelenlegi időszakra vonatkozó teljes lekérési korlát.
X-Hátralévő korlát	A jelenlegi időszakra vonatkozó fennmaradó kérelem.
X-RateLimit visszaállítása	A jelenlegi időszak végéig hátralévő másodpercek száma.

Példa a page_url paraméterrel

# 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

Kezdje el ingyen

Próbálja ki ingyen, és nincs szükség hitelkártyára. Lépjen kapcsolatba velünk, ha kérdése van.