API dokumentatsioon

Kas teil on küsimus? Võtke meiega ühendust.

Kõik API päringud tuleb teha läbi HTTPS ja vajavad URL-i päringuparameetrina api_key.

Näide

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

Edu korral saad http-vastuse staatusega 200 ja JSON info vastuse kehas.

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

API versioon

API praegune versioon on 2.0.

API põhiversioon tuleb esitata URL-is kui 'v' ja number, nt v1, v2, v3.

Näide

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

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

API meetodid

Meetod	Sisend	Väljund
PDF / loo	URL / HTML	HTML
html / loo	URL / HTML	PDF

Parameetrid

Peate esitama parameetri page_url või html. Kõik ülejäänud parameetrid on valikulised.

Parameetrid	Väärtus
Lehe URL	Sihtlehe URL
HTML	Sihtlehe HTML-sisu
Väljundi tüüp	Määrake see „attachment“, et saada PDF-fail väljundina JSON-i asemel
css_url	URL kohandatud CSS-faili jaoks
header_image_url	URL kohandatud päise pildi jaoks
Päise tekst	Teksti string

Kõik allpool olevad näited on ette nähtud "pdf/create" meetodi jaoks ja töötavad ka "html/create" meetodi jaoks.

Näide page_url parameetriga

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 sisend

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

Vead

PrintFriendly kasutab vigade üksikasjade esitamiseks tavapäraseid olekukoodid ja JSON vastuseid.

Olekukoodid

Oleku	Kirjeldus
200 OK	Kõik töötab hästi.
400 Vigane päring	Ilmnes viga. Vaata üksikasju JSON-ist.
401 Volitamata	401 Volitamata
404 Ei leitud	404 Ei leitud
429 Liiga palju päringuid	429 Liiga palju päringuid

Kõik mitte õnnestunud (mitte staatus 200) vastused sisaldavad JSON-keha koos veateabe ja veatüübi ning teatega.

Veatüübid

Tüüp	Kirjeldus
Parameetrite valideerimine	Parameetrite valideerimine ebaõnnestus.
Keelatud domeen	See domeen on ajutiselt keelatud.
Jaotamine ebaõnnestus	Lehte ei saa parsida. Me ei suuda selle lehe sisu määrata.
Toomise viga	Lehte ei saa laadida. Kontrolli, kas URL on ligipääsetav ja proovi uuesti.
kõrge koormus	Parameetrite valideerimine ebaõnnestus.
Kehtetu faili laiend	Toetatakse ainult veebilehti. See on PDF/TXT fail või pilt (JPG, PNG, GIF).
suur leht	Sihtleht on üle 2 MB. Suured lehed pole toetatud.
turvaplatvorm	Turvaplatvorm blokeerib meie juurdepääsu sellele lehele.
ajapiirang	Ajapiirang ületatud. Mootor ei suutnud lehte 30 sekundi jooksul töödelda. Palun proovige hiljem uuesti.
kõikehõlmav	Ootamatu viga. Palun proovige hiljem uuesti.

Näide

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 sisend

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

Päringute kiiruse piiramine

API-l on piirang, milleks on 60 päringut minuti kohta. Kui ületate seda piirangut, saate vastuse olekuga: 429 Liiga palju päringuid.

Päis	Kirjeldus
X-Määrakiirus-Piirang	Kogu päringute piirang praeguseks perioodiks.
X-Limiit järelejäänud	Ülejäänud taotlus praeguse perioodi jaoks.
X-RateLimiidi lähtestamine	Sekundite arv kuni praeguse perioodi lõpuni.

Näide page_url parameetriga

# 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

Alusta tasuta

Proovige tasuta ja krediitkaarti pole vaja. Võtke meiega küsimuste korral ühendust.