API-dokumentaatio

Onko kysyttävää? Ota yhteyttä.

Kaikki API-pyynnöt on tehtävä HTTPS:n kautta ja tarvitsevat api_key URL-kyselyparametrina.

Esimerkki

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

Jos onnistuu, saat http-vastauksen, jonka Tila on 200 ja JSON-tietoa vastausrungossa.

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

API-versio

API:n nykyinen versio on 2.0.

Suurin API-versio on ilmoitettava URL-osoitteessa muodossa 'v' ja numero, esim. v1, v2, v3.

Esimerkki

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

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

API-menetelmät

Menetelmä	Syöte	Lähtö
PDF / luo	URL / HTML	HTML
html / luo	URL / HTML	PDF

Parametrit

Sinun on annettava page_url- tai html-parametri. Kaikki muut parametrit ovat valinnaisia.

Parametrit	Arvo
Sivun URL	Kohdesivun URL
HTML	HTML-sisältö kohdesivulle
Tulostyyppi	Aseta se "liitteeksi", jotta PDF-tiedosto saadaan ulostulona JSONin sijaan
css_url	URL mukautetulle CSS-tiedostolle
header_image_url	URL mukautetun otsikkokuvan varten
Otsikkoteksti	Tekstimerkkijono

Kaikki alla olevat esimerkit on tarkoitettu "pdf/create"-menetelmää varten ja toimivat myös "html/create"-menetelmässä.

Esimerkki page_url-parametrilla

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-syöte

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

Virheet

PrintFriendly käyttää tavanomaisia tilakoodeja ja JSON-vastausta virhetietojen tarjoamiseen.

Tilakoodit

Tila	Kuvaus
200 OK	Kaikki toimii hyvin.
400 Virheellinen pyyntö	Tapahtui virhe. Katso yksityiskohdat JSONista.
401 Ei oikeutettu	401 Ei oikeutettu
404 Ei löydy	404 Ei löydy
429 Liian monta pyyntöä	429 Liian monta pyyntöä

Kaikki ei onnistunut (ei tila 200) vastaukset sisältävät JSON-runkoa virhetietoineen ja sisältävät virhetyypin sekä viestin.

Virhetyypit

Tyyppi	Kuvaus
Parametrien validointi	Parametrien validointi epäonnistui.
Kielletty domain	Tämä verkkotunnus on väliaikaisesti estetty.
Jäsennys epäonnistui	Sivua ei pysty prosessoimaan. Emme voi määrittää tämän sivun sisältöä.
Noutovirhe	Sivua ei voida noutaa. Tarkista, että URL on käytettävissä, ja yritä uudelleen.
korkea kuormitus	Parametrien validointi epäonnistui.
Virheellinen tiedostopääte	Vain verkkosivut ovat tuettuja. Tämä on PDF/TXT-tiedosto tai kuva (JPG, PNG, GIF).
suuri sivu	Kohdesivu on yli 2 MB. Suuria sivuja ei tueta.
turva-alusta	Turva-alusta estää tämän sivun lataamisen.
aikakatkaisu	Aikakatkaisu ylitetty. Moottori ei voi käsitellä sivua 30 sekunnissa. Yritä myöhemmin uudelleen.
kaiken kattava	Odottamaton virhe. Yritä myöhemmin uudelleen.

Esimerkki

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-syöte

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

Pyyntöjen nopeuden rajoittaminen

API:ssa on rajoitus, joka sallii vain 60 pyyntöä minuutissa. Jos ylität tämän rajan, saat vastauksen, jonka tila on: 429 Liian monta pyyntöä.

Otsikko	Kuvaus
X-Arvokatto-Raja	Kokonaispyyntöraja nykyiselle ajanjaksolle.
X-Jäljellä oleva rajoitus	Jäljellä oleva pyyntö nykyiselle kaudelle.
Nollaa X-RateLimit	Määrä sekunteja nykyisen jakson loppuun asti.

Esimerkki page_url-parametrilla

# 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

Aloita ilmaiseksi

Kokeile ilmaiseksi, eikä luottokorttia tarvita. Ota yhteyttä, jos sinulla on kysyttävää.