API dokumentatsioon
Kas teil on küsimus? Võtke meiega ühendust.
Kõik API-päringud tuleb teha üle HTTPS ja kasutada HTTP Basic Auth järgmiste mandaadiandmetega:
Username: API KEY
Password: Not needed
Näide
curl https://api.printfriendly.com/v1/pdfs/create /
-u your_api_key: /
-d page_url=https://en.wikipedia.org/wiki/Eclipse
Lipp | Kirjeldus |
|---|---|
-u | Edasta põhivautimise mandaat, API-võtme järel koolon takistab cURL-l parooli küsimist. |
-d | saada andmed POST päringus |
Eduka tulemuse korral saate HTTP vastuse olekuga 302 (Ümbersuunamine), ja JSON info on vastuse kehas.
# HTTP RESPONSE
# HEADERS (some of headers are ommited)
Content-Type: application/json; charset=utf-8
Status: 302 Found
Location: https://v.printfriendly.com/system/pdfs/pdf_1480936999_755625A4.pdf
# BODY
{"success":"Redirect to https://v.printfriendly.com/system/pdfs/pdf_1480947535_6e7ecaA4.pdf"}
API versioon
API praegune versioon on 1.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 |
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 |
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/v1/pdfs/create /
-u your_api_key: /
-d page_url=https://test.test /
-d css_url=https://my-site.com/pdf_style.css /
-d header_text='My Custom Header'
Eduka tulemuse korral saate HTTP vastuse olekuga 302 (Ümbersuunamine), ja JSON info on vastuse kehas.
Näide html-i parameetritega
curl https://api.printfriendly.com/v1/pdfs/create /
-u your_api_key: /
-d html='<html><body><h1>Title</h1><p>Text text text text text text text text text</p></body></html>'
Edu korral saate HTTP vastuse staatusega 200 ja PDF/HTML sisu vastuse kehas.
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 ebaõnnestunud (mitte Staatuse 302 OK) vastused sisaldavad JSON-keha veateabe ja tüübi ning sõnumiga.
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/v1/pdfs/create /
-u your_api_key: /
-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