የAPI ሰነዶች

ሁሉም የAPI ጥያቄዎች በHTTPS ውስጥ መላክ አለበት እና ከቀሪዎቹ ፈቃድ ጋር በHTTP Basic Auth መጠቀም አለበት:

Username: API KEY

Password: Not needed

ምሳሌ

curl https://api.printfriendly.com/v1/pdfs/create /

-u your_api_key: /

-d page_url=https://en.wikipedia.org/wiki/Eclipse

አርሶት	መግለጫ
-u	የመግቢያ መለዋወጫዎችን ያስገቡ፣ በ API ቁልፍ በኋላ አንድ ጥምሮት በ cURL የይለፍ ቃልን እንዲጠይቅ አይደለም።
-ዲ	ምስክርነትን በ POST እንደምንወክ ላክ

በ ስኬት ተከታይነት ሆኖ፤ እርስዎ HTTP እይታ 302 (እናቀናሻ) ይሰጣልና የ JSON መረጃ በእይታ አካል ውስጥ ይገኛል።

# 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 እትም

አሁን ያለው የ API እትም 1.0 ነው።

ዋና የ API እትም በ URL እንደ 'v' እና ቁጥር መቀበል አለበት፣ ለምሳሌ፡ v1, v2, v3።

ምሳሌ

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

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

የ API ዘዴዎች

ዘዴ	ግቤት	ውጤት
ፒዲኤፍ / ፍጠር	URL / HTML	HTML
html / ፍጠር	URL / HTML	ፒዲኤፍ

መለኪያዎች

እቅፍ ወይም html መካከለኛ ማቅረብ ይኖርብዎታል። አንዳንድ ሌሎች መካከለኞች ነጻ ናቸው።

መለኪያዎች	እናት
የገፅ አድራሻ	የአሰባሰቢው ገጽ አድራሻ
HTML	የነግረአንድ HTML ይዘት
css_url	URL የራስዎ ሆነው CSS ፋይል
header_image_url	የእርስዎ ራስጌ ምስል ሆን ገና
የርዕስ ጽሑፍ	የጽሑፍ ስም

በታች የተሰጡት ምሳሌዎች ሁሉም ለ "pdf/create" ዘዴ ተሰጥተዋል እና እንዲሁም ለ "html/create" ዘዴ ይሠራሉ።

አብነት ከ page_url አስተናጋጅ

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'

በ ስኬት ተከታይነት ሆኖ፤ እርስዎ HTTP እይታ 302 (እናቀናሻ) ይሰጣልና የ JSON መረጃ በእይታ አካል ውስጥ ይገኛል።

አርእስት በ html መስክዎች

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

በአስተካቂ ስኬት ሁኔታ፣ በጥያቄ አካል ውስጥ ከሁኔታ 200 ጋር PDF/HTML ይሰጣል።

አስተሳሰቦች

PrintFriendly በተለምዶ Status ኮዶች እና JSON ምላሽን ለስህተት ዝርዝር ማቅረብ ይጠቀማል።

የሁኔታ ኮድ

ሁኔታ	መግለጫ
200 ማረጋገጥ	ነገር ሁሉ በትክክል ይሠራል።
400 የተመነጠለ ጥያቄ	በስህተት አላለ። ዝርዝሮችን በ JSON ውስጥ እይ።
401 የማይፈቀድ	401 የማይፈቀድ
ፋውንድ አልተገኘም 404	ፋውንድ አልተገኘም 404
429 ጠቅላላ ጥያቄዎች ብዛት	429 ጠቅላላ ጥያቄዎች ብዛት

አልፎላለም በክብክብ ተሳካ አይደለም (ክብክብ ሁኔታ 302 OK አይደለም) ምላሽነት JSON አካል ያላቸው በሃሰት ዝርዝር ይወከሟል፣ የተሳካ ዓይነትና መልእክትን ይያዝባል።

እቅፍ አይነቶች

ዓይነት	መግለጫ
መተኮሻዎች ማረጋገጥ	አማካይነት እቅፍ ያልተሳካ።
ተከልካል የስርዓት ድር	ይህ ድር ማለት ጊዜዊ እቅፍ ተብሏል።
አልተተረጉሙም	ይቅርታ ገጽን ማሳወቅ አልቻልንም። የዚህ ገጽ ፍጥረት መወሰን አልቻልንም።
እርምጃ ስላይኖረ	የገጹን መስተዋል አልቻልኩም። URL እንደሚደረሰ እንደሆነ ያረጋግጡ እና እንደገና ይሞክሩ።
ባለ ጭነት ከፍተኛ	የአማካኝ ማረጋገጫ አልተሳካም።
የፋይል አርዳዳ ልቁታ	የድር ገጽዎች ብቻ ናቸው የተደጋገሙ። እነዚህ የ PDF/TXT ፋይል ወይም ምስሎች (JPG, PNG, GIF) ናቸው።
ትልቅ ገጽ	የታሪክ ገጽ ከ 2 ሜጋ ባይት ይበልጣል። ትልቅ ገጾች አይደገጉም።
የደህንነት መድረክ	የፈጠራ መድረክ እነዚህን ገጽ እንዳይወስድ ያስቆምታል።
የጊዜ አልቋሽ	ጊዜው አበስተካከለ። ኔምጂን ገፁን በ 30 ስኮንዶች ውስጥ ማንቀሳቀስ አልቻሉም። እባኮትን ኋላ ደግመው ይሞክሩ።
እቅፍ ሁሉ	ያልተጠበቀ ስህተት። እባኮትን በኋላ ይሞክሩና.

ምሳሌ

curl https://api.printfriendly.com/v1/pdfs/create /

-u your_api_key: /

-d page_url=https://test.test

HTML input

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

የጥያቄዎች ደረጃ አስቀመጥ

ኤፒአይ በደቂቃ 60 ጥያቄዎች ያለው አቅርቦት አለው። ይህንን ወሰን ከበለጠን ምላሽ ጋር ምንም Status: 429 በጣም ብዙ ጥያቄዎች እንደታገኝ ትረከባለህ።

አርዕስት	መግለጫ
ኤክስ-የተገደበ-ምርት	አጠቃላይ ጥያቄዎች መጠን ለወቅታዊ ጊዜ.
X-የተወሰነ-ቀሪ	የአሁኑ ጊዜ ተቀርቶ ትእዛዝ.
የ-X እንቅስቃሴ ውስብስብነት እንደገና አውልቅ	በአሁኑ ጊዜ ያለው ጊዜአቀማመጥ መጨረሻንም ከማህበረሰቡ ጊዜ እንድትቆጠራት የቀረ ሚያንሰው ሰከንዶች ብዛት።

ናሁና በ page_url መካነት

# 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

ጀምር በነፃ

አነስ ያቀናበሱት ነጻ ነው እና የክሬዲት ካርድ አስፈላጊ አይደለም። ምንም ጥያቄ ካሎት ያነጋግሩን።