API dokumentācija

Vai ir kāds jautājums? Sazinieties ar mums.

Visi API pieprasījumi jāveic caur HTTPS un nepieciešams api_key kā URL vaicājuma parametrs.

Piemērs

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

Gadījumā, ja ir veiksme, jūs saņemsiet http atbildi ar Statusu 200 un JSON informāciju atbildes saturā.

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

API versija

Pašreizējā API versija ir 2.0.

Galvenā API versija jānorāda URL, kā 'v' un numurs, piemēram, v1, v2, v3.

Piemērs

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

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

API metodes

Metode	Ievade	Izvade
PDF / izveidot	URL / HTML	HTML
html / izveidot	URL / HTML	PDF

Parametri

Jums jānorāda page_url vai html parametrs. Visi pārējie parametri ir izvēles.

Parametri	Vērtība
Lapas URL	Mērķlapas URL
HTML	HTML saturs mērķlapai
Izvades veids	Iestatiet uz "attachment", lai saņemtu PDF failu kā izvadu, nevis JSON
css_url	URL pielāgotajai CSS failai
header_image_url	URL pielāgota galvenes attēlam
Galvenes teksts	Teksta virkne

Visi zemāk minētie piemēri ir paredzēti "pdf/create" metodei un darbojas arī "html/create" metodei.

Piemērs ar 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 ievade

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

Kļūdas

PrintFriendly izmanto parastos statusa kodus un JSON atbildes, lai sniegtu kļūdu detaļas.

Statusa kodi

Statuss	Apraksts
200 Labi	Viss darbojas labi.
400 Nederīgs pieprasījums	Radās kļūda. Skatiet detalizētu informāciju JSON.
401 Neautorizēts	401 Neautorizēts
404 Nav atrasts	404 Nav atrasts
429 Pārāk daudz pieprasījumu	429 Pārāk daudz pieprasījumu

Visi neveiksmīgi (ne Status 200) atbildes satur JSON ķermeni ar kļūdas detaļām, kas ietver kļūdas veidu un ziņojumu.

Kļūdu veidi

Tips	Apraksts
Parametru validācija	Parametru validācija neizdevās.
Aizliegtā domēns	Šis domēns ir uz laiku aizliegts.
Parsēšana neizdevās	Nevar parsēt lapu. Nevar noteikt šīs lapas saturu.
Iegūšanas kļūda	Nevar ielādēt lapu. Pārbaudiet, vai URL ir pieejams, un mēģiniet vēlreiz.
augsta slodze	Parametru validācija neizdevās.
Nederīga faila paplašinājumu	Tiek atbalstītas tikai tīmekļa lapas. Tā ir PDF/TXT datne vai attēls (JPG, PNG, GIF).
liela lapa	Mērķa lapa pārsniedz 2 MB. Lielās lapas netiek atbalstītas.
drošības platforma	Drošības platforma bloķē mūsu piekļuvi šai lapai.
laika beigas	Laika limits pārsniegts. Dzinējs nevar apstrādāt lapu 30 sekunžu laikā. Lūdzu, mēģiniet vēlāk.
universāls	Neplānota kļūda. Lūdzu, mēģiniet vēlāk.

Piemērs

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 ievade

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

Pieprasījumu ātruma ierobežošana

API ir ierobežojums - 60 pieprasījumi minūtē. Ja pārsniegsiet šo ierobežojumu, saņemsiet atbildi ar Statusu: 429 Pārāk daudz pieprasījumu.

Galvene	Apraksts
X-Ātruma ierobežojums	Kopējais pieprasījumu limits pašreizējam periodam.
X-Atlikušais limits	Atlikušie pieprasījumi pašreizējam periodam.
Atiestatīt X-RateLimit	Sekunžu skaits līdz pašreizējā perioda beigām.

Piemērs ar 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

Sāciet bez maksas

Izmēģiniet bez maksas, un nav nepieciešama kredītkarte. Sazinieties ar mums, ja jums ir kādi jautājumi.