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 પદ્ધતિઓ

પદ્ધતિ	ઇનપુટ	આઉટપુટ
પીડીએફ / બનાવો	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 પ્રતિસાદનો ઉપયોગ કરે છે.

સ્થિતિ કોડ

સ્થિતિ	વર્ણન
૨૦૦ ઠીક છે	બધી વસ્તુઓ સારી રીતે કામ કરે છે.
૪૦૦ અયોગ્ય વિનંતી	ભૂલ પહોળાઈ છે. JSON માં વિગતો જુઓ.
૪૦૧ અનધિકૃત	૪૦૧ અનધિકૃત
૪૦૪ મળ્યું નથી	૪૦૪ મળ્યું નથી
429 ખુબજ વધુ વિનંતીઓ	429 ખુબજ વધુ વિનંતીઓ

બધા અસફળ (સ્થિતિ 302 OK નહીં) પ્રતિસાદમાં JSON બોડી હોય છે જે ભૂલના વિગતો સમાવશે, જેમાં ભૂલનો પ્રકાર અને સંદેશાવ્યવહાર સામેલ છે.

ભૂલ પ્રકારો

પ્રકાર	વર્ણન
પેરામિટરની ચકાસણી	પેરામીટર્સ વૅલિડેશન નિષ્ફળ રહ્યું.
પ્રતિબંધિત ડોમેન	આ ડોમેન તાત્કાલિક પ્રતિબંધિત છે.
પાર્સ કરવું નિષ્ફળ	પાનું પાર્સ કરી શકાતું નથી. અમે આ પાનાની સામગ્રી નક્કી કરી શકતા નથી.
ફેચ ભૂલ	પૃષ્ઠ લાવી શકાયું નથી. ખાતરી કરો કે 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

મફત શરુ કરો

તેને મફત પ્રયાસ કરો અને ક્રેડિટ કાર્ડની જરૂર નથી. કોઈ પ્રશ્ન હોય તો અમારો સંપર્ક કરો.