API ஆவணக்குறிப்புகள்

கேள்வி இருக்கிறதா? எங்களை தொடர்பு கொள்ளவும்.

எல்லா API கோரிக்கைகளும் HTTPS மூலம் செய்யப்பட்டு, HTTP அடிப்படை அங்கீகாரம் பின்வரும் சான்றுகளுடன் பயன்படுத்தப்பட வேண்டும்:

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 கோரிக்கையில் தரவை அனுப்பவும்

வெற்றியின் நிகழ்வில், நீங்கள் 302 (மறுஸ்திர일보) நிலை கொண்ட HTTP பதில் ஐ பெறுவீர்கள், மற்றும் 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 முறைகள்

முறைக்கள	உள்ளீடு	வெளி
PDF / உருவாக்கு	URL / HTML	HTML
html / உருவாக்கு	URL / HTML	பீடிஎப்

மாறிலிகள்

நீங்கள் page_url அல்லது html அளவுகோள் வழங்க வேண்டும். மற்ற அனைத்து அளவுகோள்களும் விருப்பவை.

மாறிலிகள்	மதிப்பு
பக்க URL	இலக்கு பக்கத்தின் URL
HTML	இலக்கு பக்கத்தின் HTML உள்ளடக்கம்
css_url	சீரமைக்கப்பட்ட CSS கோப்பிற்கான URL
header_image_url	தனிப்பயன் தலைப்பு படத்திற்கு 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'

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

வெற்றி தேவைப்பட்டால், HTTP பதில் நிலை 200 மற்றும் பதில் உடலில் PDF/HTML உள்ளடக்கம் கிடைக்கும்.

முடிர்ச்சிகள்

PrintFriendly பிழை விவரங்களை வழங்க மரபு நிலை குறியீடுகள் மற்றும் JSON பதில்களை பயன்படுத்துகிறது.

நிலை குறியீடுகள்

நிலைமை	விவரம்
200 சரி	எல்லாமும் நன்றாக வேலை செய்கிறது.
400 தவறான கோரிக்கை	ஒரு பிழை ஏற்பட்டுள்ளது. JSON இல் விவரங்களைப் பாருங்கள்.
401 அங்கீகரிக்கப்படாதது	401 அங்கீகரிக்கப்படாதது
404 கிடைக்கவில்லை	404 கிடைக்கவில்லை
429 மிக அதிக உத்தரவுகள்	429 மிக அதிக உத்தரவுகள்

அனைத்து வெற்றிகரமாக இல்லை (நிலை 302 OK இல்லை) பதில்களுக்கு பிழை விவரங்களை உள்ளடக்கிய JSONஉடல் உள்ளது, இதில் பிழை வகை மற்றும் செய்தி அடங்கும்.

பிழை வகைகள்

வகை	விவரம்
அளவுருக்களின் doğrтықபடுத்துதல்	அளவுருக்கள் சரிபார்ப்பு தோல்வியடைந்தது.
தடை செய்யப்பட்ட டொமெயின்	இந்த டொமைன் தற்காலிகமாக தடை செய்யப்பட்டது.
படிக்கத் தவறிவிட்டது	பக்கத்தை பதிப்பிக்க முடியவில்லை. இந்த பக்கத்தின் உள்ளடக்கத்தை நாங்கள் கணிக்க முடியவில்லை.
கோப்பினை எடுக்க முடியவில்லை	பக்கத்தை பெற முடியவில்லை. URL அணுகக்கூடியது என்பதைச் சரிபார்த்து மீண்டும் முயற்சிக்கவும்.
உயர் சுமை	அளவுரு சரிபார்ப்பு தோலைமடைந்தது.
செல்லாத கோப்பு செயல்பாடு	வலைப்பக்கங்களே மட்டுமே ஆதரவளிக்கப்படும். இது PDF/TXT கோப்பு அல்லது படம் (JPG, PNG, GIF).
பெரிய பக்கம்	இலக்கு பக்கம் 2MB-ஐக் கூடுதல் உள்ளது. பெரிய பக்கங்கள் ஆதரிக்கப்படவில்லை.
பாதுகாப்பு தளம்	பாதுகாப்பு தளம் இந்த பக்கத்தை எடுக்கவிழைவதை தடை செய்கிறது.
நேரம் முடிந்தது	கால எல்லை மிஞ்சியது. என்ஜின் 30 விநாடிகளில் பக்கத்தை செயல்படுத்து முடியவில்லை. தயவுசெய்து பின்னர் மீண்டும் முயற்சி செய்யவும்.
அனைத்தும்	எதிர்பாராத பிழை. தயவுசெய்து பின்னர் முயற்சிக்கவும்.

எடுத்துக்காட்டு

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

-u your_api_key: /

-d page_url=https://test.test

HTML உள்ளீடு

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

கோரிக்கைகள் விகித வரம்பு

APIக்கு ஒரு நிமிடத்திற்கு 60 கோரிக்கைகளின் வரம்பு உள்ளது. நீங்கள் இந்த வரம்பை மீறினால், நிலை: 429 அதிக கோரிக்கைகளுடன் ஒரு பதிலைப் பெறுவீர்கள்.

தலைப்பு	விவரம்
X-மதிப்பீடு வரம்பு	தற்போதைய காலத்திற்கான மொத்த கோரிக்கைகள் வரம்பு.
X-மீதமுள்ள வரம்பு	தற்போதைய காலத்திற்கான மீதமான கோரிக்கை.
X-RateLimit மீண்டும் அமைக்கவும்	தற்போதைய காலத்தின் முடிவிற்கு செகன்களின் அளவு.

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

இலவசமாக தொடங்குங்கள்

இதை இலவசமாக முயற்சி செய்து பாருங்கள், எவ்வித கிரெடிட் கார்டு தேவையில்லை. எதாவது கேள்விகள் இருந்தால் எங்களைத் தொடர்பு கொள்ளுங்கள்.