API dokumentacija

Turite klausimų? Susisiekite su mumis.

Visi API užklausas turi būti vykdomi per HTTPS ir reikalauja api_key kaip URL užklausos parametro.

Pavyzdys

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

Jei yra sėkmė, gausite http atsakymą su Statusu 200 ir JSON informaciją atsakymo kūne.

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

API versija

Dabartinė API versija yra 2.0.

Pagrindinė API versija turi būti nurodyta URL kaip 'v' ir skaičius, pvz., v1, v2, v3.

Pavyzdys

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

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

API metodai

Metodas	Įvestis	Išvestis
PDF / kurti	URL / HTML	HTML
html / sukurti	URL / HTML	PDF

Parametrai

Privalote pateikti page_url arba html parametrą. Visi kiti parametrai yra pasirenkami.

Parametrai	Vertė
Puslapio URL	Tikslinio puslapio URL
HTML	Tikslinio puslapio HTML turinys
Išvesties tipas	Nustatykite „attachment“, kad PDF failą gautumėte kaip rezultatą vietoj JSON
css_url	URL pagal užsakymą CSS failui
header_image_url	URL pasirinktinio antraštės vaizdo
Antraštės tekstas	Teksto eilutė

Visi žemiau pateikti pavyzdžiai yra skirti "pdf/create" metodui ir taip pat veikia "html/create" metodui.

Pavyzdys su page_url parametru

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 įvestis

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

Klaidos

PrintFriendly naudoja įprastus būsenos kodus ir JSON atsakymus klaidos detalėms pateikti.

Būsenos kodai

Būsena	Aprašymas
200 Gerai	Viskas veikia gerai.
400 Klaidinga užklausa	Įvyko klaida. Žr. detales JSON.
401 Neleistina	401 Neleistina
404 Nerasta	404 Nerasta
429 Per daug užklausų	429 Per daug užklausų

Visi ne sėkmingi (ne statusas 200) atsakymai turi JSON kūną su klaidos detalėmis ir apima klaidos tipą bei pranešimą.

Klaidų tipai

Tipas	Aprašymas
Parametrų patvirtinimas	Parametrų patvirtinimas nepavyko.
Draudžiama domenas	Šis domenas laikinai uždraustas.
Nepavyko išskirti	Nepavyksta analizuoti puslapio. Negalime nustatyti šio puslapio turinio.
Gavimo klaida	Nepavyksta įkelti puslapio. Patikrinkite, ar URL yra prieinamas, ir bandykite dar kartą.
didelė apkrova	Parametrų tikrinimas nepavyko.
Neleistinas failo plėtinys	Palaikomi tik tinklalapiai. Tai yra PDF/TXT failas arba vaizdas (JPG, PNG, GIF).
didelis puslapis	Tikslinis puslapis viršija 2 MB. Dideli puslapiai nepalaikomi.
saugumo platforma	Saugumo platforma blokuoja mūsų prieigą prie šio puslapio.
laiko pabaiga	Viršytas laiko limitas. Variklis negali apdoroti puslapio per 30 sekundžių. Bandykite dar kartą vėliau.
viskas-apimančio	Netikėta klaida. Bandykite dar kartą vėliau.

Pavyzdys

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 įvestis

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

Užklausų dažnio ribojimas

API turi apribojimą – 60 užklausų per minutę. Jei viršysite šį apribojimą, gausite atsakymą, kurio būsenos kodas: 429 Per daug užklausų.

Antraštė	Aprašymas
X-Didelės spartos limitas	Bendras užklausų limitas dabartiniam laikotarpiui.
X-Liko limitas	Likęs prašymas dabartiniam periodui.
Iš naujo nustatyti X-RateLimit	Sekundžių skaičius iki dabartinio laikotarpio pabaigos.

Pavyzdys su page_url parametru

# 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

Pradėkite nemokamai

Išbandykite nemokamai ir nereikia kredito kortelės. Kreipkitės į mus, jei turite klausimų.