API कुंजी प्राप्त करें

API सर्वर

सभी API अनुरोध REST- शैली URLs के लिए मानक HTTP अनुरोध हैं। प्रत्युत्तर या तो JSON हैं, या इमेज (परिणाम प्राप्त करते समय) हैं।

प्रमाणीकरण

API मानक HTTP मूलभूत पहुँच प्रमाणीकरण का इस्तेमाल करता है। API के प्रति सभी अनुरोधों में, उपयोगकर्ता के रूप में API Id और पासवर्ड के रूप में API सीक्रेट के साथ API क्रेडेंशियल्स को शामिल करने की जरूरत होगी। ध्यान दें कि आपके उपयोगकर्ताओं को आपकी API सीक्रेट प्रकट करने से बचने के लिए,ClippingMagic.js केवल आपकी API Id का इस्तेमाल करता है।

सुरक्षा

सभी अनुरोध HTTPS के ऊपर किए जाने होंगे, और आपको सभी अनुरोधों को प्रमाणित करना होगा।

अनुरोधों को सफलतापूर्वक करने के लिए आपकी http क्लायंट लाइब्रेरी को सर्वर नाम सूचना (SNI) का समर्थन करना होगा। यदि आप अजीब हैंडशेक एरर्स का सामना कर रहे हैं, तो इसकी सबसे अधिक संभावना है।

बैकएंड बनाम फ्रंटएंड

ध्यान दें कि सभी अपलोड और डाउनलोड प्रचालन बैकएंड पर होते हैं, परंतु सभी क्लिपिंग प्रचालन स्मार्ट एडीटर में होते हैं।

यह विभाजन आपकी साइट पर बाधा-रहित अंत्य-उपयोगकर्ता अनुभव सक्षम करते हुए, आपकी API कुंजी सुरक्षित रखता है।

रेट सीमित करना

API का इस्तेमाल उदार छूट सहित और आपके API क्रेडिट से परे कड़ी ऊपरी सीमा दर के बिना रेट सीमित है।

सामान्य अंत्य-उपयोगकर्ता-संचालित प्रचालन के दौरान आपके द्वारा दर सीमा का सामना करने की आशंका कम है क्योंकि तब इस्तेमाल कम होने लगता है और इस तरह प्रवाहित होता है कि इसे सेवा द्वारा गरिमामय तरीके से संभाल लिया जाता है।

फिर भी, बैच आधारित कामों के लिए हम अधिकतम 5 थ्रेड्स के साथ शुरुआत करने की सलाह देते हैं, फिर प्रत्येक 5 मिनट में 1 नया थ्रेड तब तक जोड़ते रहें, जब तक कि आप समरूपता के वांछित स्तर तक नहीं पहुंच जाते। यदि आपको 100 से अधिक समवर्ती थ्रेड्स की आवश्यकता हो, तो शुरू करने से पहले कृपया संपर्क करें।

यदि आप अत्यधिक अनुरोध प्रस्तुत करते हैं तो आपको 429 Too Many Requests प्रत्युत्तर मिलने शुरू हो जाएंगे। जब भी ऐसा हो तो आपको रैखिक बैक ऑफ लागू करना चाहिए: पहली बार ऐसा प्रत्युत्तर मिलने पर, अगला अनुरोध प्रस्तुत करने तक 5 सेकंड इंतज़ार करें। लगातार दूसरे 429 प्रत्युत्तर पर, अगला अनुरोध प्रस्तुत करने तक 2*5 = 10 सेकंड इंतज़ार करें। तीसरे में 3*5 = 15 सेकंड इंतज़ार करें, इत्यादि।

सफल अनुरोध के बाद आप बैक ऑफ काउंटर रीसेट कर सकते हैं, और आपको बैक-ऑफ को प्रति-थ्रेड के आधार पर लागू करना चाहिए (अर्थात थ्रेड्स को एक दूसरे से स्वतंत्र रूप से काम करना चाहिए)।

एरर JSON ऑबजेक्ट

हम API अनुरोध की सफलता या विफलता को इंगित करने के लिए पारंपरिक HTTP स्थितियों का इस्तेमाल करते हैं, और वापस दिए जाने वाले एरर JSON ऑबजेक्ट में महत्वपूर्ण एरर जानकारी शामिल करते हैं।

किसी भी समस्याग्रस्त अनुरोध में हम सदैव एरर JSON ऑबजेक्ट को वापस देने का प्रयास करते हैं। फिर भी, सैद्धांतिक रूप से यह सदैव संभव है कि ऐसी आंतरिक सर्वर विफलताएं हुई हों जो गैर-JSON एरर प्रत्युत्तर का कारण बनती हैं।

विशेषताएं
statusडिबगिंग में सहायता के लिए यहाँ प्रत्युत्तर की HTTP स्थिति दोहराई गई।
codeClipping Magic आंतरिक त्रुटि कोड।
messageडिबगिंग में सहायक होने के प्रयोजन से मानव-पठनीय एरर संदेश।

यदि आपके अनुरोध के लिए HTTP स्थिति 200 है, तो एरर रहित JSON ऑबजेक्ट वापस किया जाएगा, और आप आराम से यह मान सकते हैं कि अनुरोध व्यापक रूप से सफल हुआ।

कुछ HTTP क्लायंट लाइब्रेरियों ने 400-599 रेंज में HTTP स्थिति के लिए अपवाद सृजित किया। आपको उन अपवादों को समझने और उन पर उचित रूप से कार्रवाई करने की आवश्यकता होगी।

HTTP Statusअर्थ
200-299

सफलता
400-499

अनुरोध में दी गई जानकारी में समस्या है (जैसे एक मापदंड गायब था)। यह जानने के लिए कि इसे कैसे ठीक किया जाए, कृपया एरर संदेश की समेक्षा करें।

500-599

एक Clipping Magic आंतरिक त्रुटि हुई है। एक क्षण रुकें, फिर प्रयास करें, और यदि समस्या बनी रहती है, तो कृपया हमें ईमेल करें।

आपकी डिबगिंग को सुविधाजनक बनाने के लिए हाल ही की API त्रुटियाँ आपके अकाउंट पेज पर सूचीबद्ध हैं।

उदाहरण एरर प्रत्युत्तर

{
  "error" : {
    "status" : 400,
    "code" : 1006,
    "message" : "Failed to read the supplied image. "
  }
}

इमेज JSON ऑबजेक्ट

JSON ऑबजेक्ट के साथ इमेज रिकॉर्ड्स एक समान तरीके से दर्शाए गए हैं, जो अनेक API कार्रवाइयों में लौटाए गए हैं।

विशेषताएं
id

इमेज के लिए विशिष्ट पहचानकर्ता। आवश्यकता है कि यह उपयोगकर्ताओं को इमेज संपादित करने और इसके परिणाम डाउनलोड करने दे।

secret ClippingMagic.js के साथ यह इमेज संपादित करने के लिए

गुप्त कुंजी की जरूरत है

resultRevision

पूर्णांक डाउनलोड के लिए उपलब्ध सबसे नवीनतम संशोधन का संकेत देता है (0 = अभी तक कोई परिणाम उपलब्ध नहीं है)।

आपको यह निर्धारित करने देता है कि आपके द्वारा पहले डाउनलोड किए गए की तुलना में इस इमेज के लिए कोई नया परिणाम उपलब्ध है या नहीं।

originalFilename

मूल इमेज अपलोड करते समय फाइलनाम वाली स्ट्रिंग प्रदान की गई।

test

true का अर्थ है कि यह परीक्षण इमेज है जिसे मुफ्त प्रोसेस किया जा सकता है, परंतु परिणाम में वॉटरमार्क होगा।

false का अर्थ है कि यह एक उत्पादन इमेज है जिसे प्रोसेस करने के लिए क्रेडिट्स की लागत आती है परंतु परिणाम में वॉटरमार्क नहीं होगा।

उदाहरण

{
  "id" : 2346,
  "secret" : "image_secret1",
  "resultRevision" : 0,
  "originalFilename" : "example_image1.jpg",
  "imageCategoryUser" : "Photo",
  "imageCategoryAi" : "Photo",
  "test" : false
}

अपलोड करें POST https://clippingmagic.com/api/v1/images

इमेज अपलोड करने के लिए, आप मानक HTTP POST फाइल अपलोड करते हैं। यह एंडपॉइंट आपके बैकएंड से करना होगा, इसे आपके वेब पेज की javascript से नहीं किया जा सकता है। ध्यान रखें कि बाइनरी फाइलों को अपलोड करते समय सामग्री-प्रकार को multipart/form-data में होना चाहिएmultipart/form-data

पैरामीटर्स

इनपुट इमेज निम्न प्रकार की होनी ज़रूरी है:

image
बाइनरी

एक बाइनरी फाइल।

image.base64
स्ट्रिंग

एक base64-एनकोडिड स्ट्रिंग स्ट्रिंग आकार में अधिक से अधिक 1megabyte हो सकता है।

image.url
स्ट्रिंग

पहुंचने के लिए URL

.bmp, .gif, .jpeg, .png, or .tiff फाइल होना ज़रूरी है।

अधिकतम इमेज अपलोड आकार (= चौड़ाई × ऊंचाई) 3,35,54,432 pixels है, जो 41,94,404 pixels तक सिकुड़ जाता है जब तक कि नीचे दिए maxPixels द्वारा ओवरराइड नहीं किया गया हो। कृपया अपलोड करने से पहले ही अपनी इमेजेस को बाद वाले या कम आकार में पहले से श्रिंक करें।

test
बूलियन
true, false

यह इंगित करने के लिए कि यह एक परीक्षण इमेज है, true में पास करें।

प्रोडक्शन इमेजिस के लिए false में छोड़ना या गुजरना।

परीक्षण इमेजेस मुफ्त प्रोसेस की जा सकती हैं, परंतु परिणाम में वॉटरमार्क एम्बेडेड होगा।

format
एनम
json, result, clipping_path_svg, clipping_path_tiff, alpha_mask_png

format=json (डिफ़ॉल्ट रूप से): कोई ऑटो-क्लिप परिणाम सृजित नहीं होता है और इमेज JSON ऑबजेक्ट वापस आ जाता है। इसका इस्तेमाल तब करें जब मानव ऑपरेटर समीक्षा कर रहा है और ClippingMagic.js का इस्तेमाल करते क्लिप को संभावित रूप से ट्च अप कर रहा है।

format=result ऑटो-क्लिप परिणाम सृजित और प्राप्त करता है।

format=clipping_path_svg ऑटो-क्लिप परिणाम सृजित करता है और Clipping Path (SVG) प्राप्त करता है।

format=clipping_path_tiff ऑटो-क्लिप परिणाम सृजित करता है और Clipping Path (TIFF) प्राप्त करता है।

format=alpha_mask_png ऑटो-क्लिप परिणाम सृजित और अल्फ़ा मास्क (PNG) प्राप्त करता है। अल्फ़ा मास्क का वही आकार होता है जो इनपुट इमेज का होता है। इसे इनपुट इमेज पर लागू करने से आपको परिणाम प्राप्त नहीं होगा, क्योंकि एज़ गार्ड और हेलो स्क्रबर बाउंडरी कलर को बेहतर बनाते हैं।

जब गैर-JSON परिणाम प्राप्त किया जाना हो तब id और secret को x-amz-meta-id और x-amz-meta-secret हेडरों में लौटाया जाता है। इन्हें संभालना याद रखें ताकि आप ClippingMagic.js का इस्तेमाल कर अपने परिणाम की समीक्षा और संपादन कर सकें। इस प्रत्युत्तर में शामिल सभी हेडर्स देखें

इमेज JSON ऑबजेक्ट प्राप्त करना आपके अकाउंट पर शुल्क नहीं लगाता है; आपसे केवल उत्पादन परिणामों को डाउनलोड करते समय शुल्क लिया जाता है।

maxPixels
इंटीगर
1000000 से 26214400

अपलोड के बाद इमेज का आकार बदलने पर यह इस्तेमाल किया गया अधिकतम इमेज आकार (= चौड़ाई × ऊंचाई) बदल देता है।

डिफ़ॉल्ट: 41,94,404pixels

background.color
#RRGGBB
#0055FF

पारदर्शी बैकग्राउंड का इस्तेमाल करने के लिए छोड़ें और PNG परिणाम प्राप्त करें।

बताए गए रंग की अपारदर्शी बैकग्राउंड और output.opaqueFileFormat परिणाम (डिफ़ॉल्ट JPEG) प्राप्त करने के लिए शामिल करें।

'#' शामिल करना याद रखें।

प्रोसैसिंग पैरामीटर्स को कॉन्फ़िगर करें:

processing.mode
एनम
auto, photo, graphics, scan

अपनी इमेज के लिए प्रोसैसिंग मोड को कंट्रोल करें।

डिफ़ॉल्ट: auto

processing.autoClip
बूलियन
true, false

वेब ऐप में इमेज को एडिट करते समय ऑटो-क्लिप को एनेबल (डिफ़ॉल्ट) या डिसेबल करें।

अक्षम करें यदि आप इमेज को API के माध्यम से अपलोड करना चाहते हैं, लेकिन फिर स्पष्ट फोरग्राउंड (यदि कोई हो) के अलावा किसी अन्य चीज़ की फ़्री-फ़ॉर्म क्लिपिंग करें।

डिफ़ॉल्ट: true

processing.autoHair
बूलियन
true, false

एक ऑटोमैटिक हेयर मास्क के अनुप्रयोग को सक्षम (डिफ़ॉल्ट) या असक्षम करें।

डिफ़ॉल्ट: true

processing.allowGraphicsMode
बूलियन
true, false

ग्राफ़िक्स मोड के ऑटोमैटिक चयन को सक्षम (डिफ़ॉल्ट) या असक्षम करें।

यह सेटिंग तब लागू नहीं होती जब format=json.

डिफ़ॉल्ट: true

processing.allowScanMode
बूलियन
true, false

स्कैन मोड के ऑटोमैटिक चयन को सक्षम (डिफ़ॉल्ट) या असक्षम करें।

यह सेटिंग तब लागू नहीं होती जब format=json.

डिफ़ॉल्ट: true

रंग के स्तर को कॉन्फ़िगर करें:

colors.auto
बूलियन
true, false

कंट्रास्ट बढ़ाने के लिए रंग स्तरों को स्वचालित रूप से समायोजित करें।

डिफ़ॉल्ट: false

colors.brightness
इंटीगर
-100 से 100

आउटपुट इमेज की चमक को समायोजित करें।

डिफ़ॉल्ट: 0

colors.shadows
इंटीगर
-100 से 100

आउटपुट इमेज की शैडोज को समायोजित करें। पॉज़ीटिव वैल्यू का मतलब है डार्कर शैडोज।

डिफ़ॉल्ट: 0

colors.highlights
इंटीगर
-100 से 100

आउटपुट इमेज की हाइलाइट्स को समायोजित करें। पॉज़ीटिव वैल्यू का मतलब है हल्की हाईलाइट्स।

डिफ़ॉल्ट: 0

colors.temperature
इंटीगर
-100 से 100

आउटपुट इमेज के रंग के तापमान को समायोजित करें। पॉज़ीटिव वैल्यू का मतलब है वार्मर कलर।

डिफ़ॉल्ट: 0

colors.saturation
इंटीगर
-100 से 100

आउटपुट इमेज के सैचुरेशन को समायोजित करें। पॉज़ीटिव वैल्यू का मतलब है डार्कर सैचुरेशन।

डिफ़ॉल्ट: 0

बैकग्राउंड से किसी रंग को हटाने को कॉन्फ़िगर करें जो फोरग्राउंड पर डाली गई है, जैसे कि हरे रंग की स्क्रीन के साथ:

colorCast.auto
बूलियन
true, false

फोरग्राउंड से हटाने के लिए बैकग्राउंड कलर को ऑटोमैटिकली निर्धारित करें।

डिफ़ॉल्ट: false

colorCast.color
#RRGGBB
#A84400

फोरग्राउंड से हटाने के लिए अपने-आप निर्दिष्ट किया गया बैकग्राउंड कलर।

ऑटोमैटिकली पता लगाने के लिए छोड़ें।

colorCast.foregroundGuard
फ्लोट
0.0 से 20.0

बड़ी वैल्यूज़ वास्तविक फोरग्राउंड रंगों पर कलर कास्ट हटाने के प्रभाव को कम करती हैं जो कि रंग के समान होते हैं लेकिन हटाए जाने की तुलना में अधिक संतृप्त होते हैं।

डिफ़ॉल्ट: 4.0

व्हाइट बैलेंस को कॉन्फ़िगर करें:

whiteBalance.auto
बूलियन
true, false

व्हाइट बैलंसिंग करने के लिए उपयोग करने के लिए संदर्भ रंग को स्वचालित रूप से निर्धारित करें।

डिफ़ॉल्ट: false

whiteBalance.color
#RRGGBB
#968386

अपने-आप निर्दिष्ट किया गया व्हाइट बैलेंस कलर।

ऑटोमैटिकली पता लगाने के लिए छोड़ें।

फिनिंशिंग टच को कॉन्फ़िगर करें:

effects.dropShadow
[xOffsetPx:int] [yOffsetPx:int] [blurRadiusPx:int, 0 to 75] [opacity:float, 0 to 1]
30 30 25 0.75

क्लिप किए गए परिणामों पर ड्रॉप शैडो इफैक्ट जोड़ें।

effects.reflection
[yOffsetPx:int, 0 to 400] [heightPx:int, 0 to 800] [opacity:float, 0 to 1]
0 200 0.5

क्लिप किए गए परिणामों पर प्रतिबिंब इफैक्ट जोड़ें।

किनारों के पैरामीटर्स को कॉन्फ़िगर करें:

edges.corners
बूलियन
true, false

कॉर्नर गार्ड का इस्तेमाल करें (डिफ़ॉल्ट) या उसे डिसेबल करें।

edges.smoothing
एनम
smart, fixed

smart (डिफ़ॉल्ट) या fixedस्मूदिंग का इस्तेमाल करें।

edges.smoothingLevel
फ्लोट
0.0 से 10.0

परिणाम पर लगाई जाने वाली स्मूदिंग की मात्रा को कॉन्फ़िगर करें।

डिफ़ॉल्ट 1.0

edges.feathering
एनम
fixed, auto, local

auto (डिफ़ॉल्ट) local, या fixed फैदरिंग का इस्तेमाल करें।

edges.featheringRadiusPx
फ्लोट
0.0 से 6.0

परिणाम पर लगाई जाने वाली फैदरिंग की मात्रा को कॉन्फ़िगर करें।

डिफ़ॉल्ट: 1.0

edges.offsetPx
फ्लोट
0.0 से 10.0

परिणाम पर लगाए जाने वाले बाउंडरी ऑफ़सेट को कॉन्फ़िगर करें।

डिफ़ॉल्ट: 0.0

परिणाम पर आउटपुट को समायोजित करें

fit.toResult
बूलियन
true, false

परिणाम पर फिट करें को चालू या बंद (डिफ़ॉल्ट) करें।

अगर यह बंद होता है तो इस खंड के बाकी मापदंडों को प्रभावी ढंग से नजरअंदाज किया जाता है।

fit.paddingPercent
फ्लोट
0.0 से 35.0

परिणामी आकार के प्रतिशत के रूप में, फिट किए गए परिणाम के चारों ओर लगाने के लिए पैडिंग।

डिफ़ॉल्ट: 5.0

fit.paddingPixels
इंटीगर
0 से 250

फिट किए गए परिणाम के चारों ओर लगाने के लिए पिक्सेल में पैडिंग।

यदि बताया नहीं जात है, तो एक प्रतिशत पैडिंग का इस्तेमाल किया जाता है।

fit.objectSize
एनम
small, medium, large

आप अपने ऑब्जेक्ट के लिए सिंथेटिक आकार निर्धारित कर सकते हैं। यह ईकामर्स के लिए उपयोगी है जहां आप खरीददारों को अन्य उत्पादों के सापेक्ष अपने उत्पाद के आकार को मोटे तौर पर बताना चाहते हों।

डिफ़ॉल्ट: large (+ परिणाम को पुन: आकार नहीं दिया गया है)

fit.verticalAlignment
एनम
top, middle, bottom

निर्दिष्ट करें कि यदि बहुत अधिक वर्टिकल स्थान मौजूद है, तो आपका परिणाम कैसे संरेखित किया जाना चाहिए।

पहलू अनुपात या लक्ष्य आकार प्रवर्तन के कारण अतिरिक्त स्थान वितरित करते समय भी लागू होता है, नीचे देखें।

डिफ़ॉल्ट: middle

fit.shadows
एनम
ignore, pad, tight

आप शैडोज को फिट करने के लिए दोनों तरफ समान रूप से शैडोज को अनदेखा कर सकते हैं, या केवल पैडिंग को जोड़ने के लिए कस सकते हैं जहां शैडोज को काटने की आवश्यकता नहीं होती है।

डिफ़ॉल्ट: pad

fit.rotationDeg
फ्लोट
-360.0 से 360.0

इमेज को घुमाएँ। पॉजीटिव वैल्यूज़ घड़ी की सुईयों के विपरीत होती हैं।

डिफ़ॉल्ट: 0

परिणाम के आकार और ऑस्पैक्ट रेशो को नियंत्रित करें:

result.aspectRatio
[width:float, >0]:[height:float, >0]
4:3

सुनिश्चित करें कि परिणाम में दी गई ऑस्पैक्ट रेशो है।

fit.verticalAlignment नियंत्रित करता है कि कैसे अधिक वर्टिकल स्थान को बांटा जाए।

डिफ़ॉल्ट: लागू नहीं किया गया।

result.targetSize
[width:int, >0] [height:int, >0]
400 300

सुनिश्चित करें कि परिणाम में प्रदान किया गया आकार है।

fit.verticalAlignment नियंत्रित करता है कि कैसे अधिक वर्टिकल स्थान को बांटा जाए।

डिफ़ॉल्ट: लागू नहीं किया गया।

result.allowEnlarging
बूलियन
true, false

नियंत्रित करता है कि अगर परिणाम इनपुट इमेज से बड़ा बनने की अनुमति देता है या नहीं।

डिफ़ॉल्ट: false

आउटपुट विकल्प को नियंत्रित करता है:

output.dpi
इंटीगर
1 से 4000

परिणाम में एम्बेडेड DPI जानकारी सेट करें।

परिणाम में DPI जानकारी शामिल नहीं होती यदि परिणाम वेब अनुकूलित है।

डिफ़ॉल्ट: 72

output.colorSpace
एनम
sRGB, AdobeRGB, AppleRGB, ColorMatchRGB

परिणाम में एम्बेडेड कलर स्पेस जानकारी सेट करें।

कलर स्पेस जानकारी शामिल नहीं होती यदि परिणाम वेब अनुकूलित है।

डिफ़ॉल्ट: sRGB

output.jpegQuality
इंटीगर
1 से 100

JPEG परिणाम का उत्पादन करते समय उपयोग की जाने वाली गुणवत्ता सेटिंग कॉन्फ़िगर करें।

डिफ़ॉल्ट: 75

output.pngOptimization
एनम
none, lossless, lossy

PNG परिणामों के वेब अनुकूलन को कॉन्फ़िगर करें।

डिफ़ॉल्ट: lossless

output.jpegOptimization
एनम
none, enabled

JPEG परिणामों के वेब अनुकूलन को कॉन्फ़िगर करें।

डिफ़ॉल्ट: enabled

output.opaqueFileFormat
एनम
jpeg, png

अपारदर्शी परिणामों के लिए उपयोग करने के लिए फ़ाइल फॉर्मैट कॉन्फ़िगर करें।

डिफ़ॉल्ट: jpeg

आप सदस्यता के बिना परीक्षण मोड में इमेजेस अपलोड कर सकते हैं। फिर भी, भले ही अपलोड में क्रेडिट की लागत नहीं आती है, आपको इसके बावजूद API के माध्यम से उत्पादन इमेजेस को अपलोड करने के लिए मान्य API सदस्यता की आवश्यकता होती है।

इसे आज़माएं

फॉर्मैट: '#RRGGBB'
फॉर्मैट: '#RRGGBB'
फॉर्मैट: '#RRGGBB'

फॉर्मैट: '[xOffsetPx:int] [yOffsetPx:int] [blurRadiusPx:int, 0 to 75] [opacity:float, 0 to 1]'
उदाहरण: 30 30 25 0.75

फॉर्मैट: '[yOffsetPx:int, 0 to 400] [heightPx:int, 0 to 800] [opacity:float, 0 to 1]'
उदाहरण: 0 200 0.5

फॉर्मैट: '[width:float, >0]:[height:float, >0]'
उदाहरण: 4:3

फॉर्मैट: '[width:int, >0] [height:int, >0]'
उदाहरण: 400 300

यूज़रनेम = API आईडी, पासवर्ड = API सीक्रेट

cURL

$ curl "https://clippingmagic.com/api/v1/images" \
 -u 123:[secret] \ 
 -F 'image=@example.jpg' \ 
 -F 'test=true'

मानता है कि 'example.jpg' मौजूद है। उपयुक्त रूप में बदलें। 'परीक्षण=वास्तविक' वैकल्पिक के अनुरूप।

उदाहरण प्रत्युत्तर

{
  "image" : {
    "id" : 2346,
    "secret" : "image_secret1",
    "resultRevision" : 0,
    "originalFilename" : "example_image1.jpg",
    "imageCategoryUser" : "Photo",
    "imageCategoryAi" : "Photo",
    "test" : false
  }
}

डाउनलोड करें GET https://clippingmagic.com/api/v1/images/[imageId]

परिणाम डाउनलोड करने के लिए, आप मानक HTTP GET करें। परिणाम हमेशा पहले तैयार किया हुआ होना चाहिए।

परीक्षण परिणामों को मुफ्त डाउनलोड किया जा सकता है, परंतु इनमें वाटरमार्क शामिल होता है। उत्पादन परिणामों में पहली बार डाउनलोड करने पर एक क्रेडिट की लागत होती है; दोबारा किए जाने वाले डाउनलोड्स मुफ्त हैं।

यदि कोई परिणाम उपलब्ध न हो, तो आपको एरर संबंधी प्रत्युत्तर मिलेगा।

पैरामीटर्स
imageId

URL में समाहित किया गया

आपको वह id मान डालने की जरूरत होगी जो कि अपलोड कॉल में वापस किया गया था।

वैकल्पिक
format

format=result (डिफॉल्ट) परिणाम इमेज वापस की जाती है।

format=clipping_path_svg इसकी बजाय Clipping Path (SVG) प्राप्त करता है।

format=clipping_path_tiff इसकी बजाय Clipping Path (TIFF) प्राप्त करता है।

format=alpha_mask_png इसकी बजाय Alpha Mask (PNG) प्राप्त करता है।

format=json इसकी बजाय इमेज JSON ऑबजेक्ट प्राप्त करता है। यदि आप resultRevision पर जाँचना चाहते हों, या यदि आपने इमेज रहस्य खो दिया हो तो उपयोगी है।

इमेज JSON ऑबजेक्ट प्राप्त करना आपके अकाउंट पर शुल्क नहीं लगाता है; आपसे केवल उत्पादन परिणामों को डाउनलोड करते समय शुल्क लिया जाता है।

प्रतिक्रिया के हेडर

जब format json नहीं है, हम इन HTTP प्रतिक्रिया हेडर में महत्वपूर्ण जानकारी प्रदान करते हैं

x-amz-meta-id
Example: 2346

आपकी इमेज id है।

x-amz-meta-secret
Example: image_secret1

आपकी इमेज secret है।

x-amz-meta-resultrevision
Example: 1

resultRevision, जिसे आप इस अनुरोध में प्राप्त कर रहे हैं।

हर बार एक नया परिणाम उत्पन्न होने पर यह काउंटर बढ़ जाता है।

x-amz-meta-width
Example: 3200
(केवल format=result के लिए शामिल है)

इस अनुरोध में आपके द्वारा प्राप्त किए जा रहे परिणाम के पिक्सेल में चौड़ाई।

x-amz-meta-height
Example: 2400
(केवल format=result के लिए शामिल है)

इस अनुरोध में आपके द्वारा प्राप्त किए जा रहे परिणाम के पिक्सेल में लम्बाई।

Content-Disposition
Example: attachment; filename*=UTF-8''example_image1_clipped_rev_0.png

परिणाम फ़ाइल का नाम, जिसमें एक्सटेंशन शामिल है।

इसे आज़माएं

यूज़रनेम = API आईडी, पासवर्ड = API सीक्रेट

cURL

$ curl "https://clippingmagic.com/api/v1/images/2346" \
 -u 123:[secret] \ 
 -LOJ

उदाहरण JSON प्रत्युत्तर

{
  "image" : {
    "id" : 2346,
    "secret" : "image_secret1",
    "resultRevision" : 0,
    "originalFilename" : "example_image1.jpg",
    "imageCategoryUser" : "Photo",
    "imageCategoryAi" : "Photo",
    "test" : false
  }
}

सूचीबद्ध करें GET https://clippingmagic.com/api/v1/images

आपकी इमेज JSON ऑबजेक्ट्स की सूची प्राप्त करने के लिए, आप मानक HTTP GET करें

पैरामीटर्स
वैकल्पिक
limit

प्राप्त किए जाने वाले रिकॉर्ड्स की संख्या। डिफॉल्ट रूप से 20 (न्यूनतम 1, अधिकतम 100)।

वैकल्पिक
offset

रिकॉर्डस की सूची में इस्तेमाल किया जाने वाला ऑफसेट (डिफॉल्ट रूप से 0).

प्रत्युत्तर विशेषताएं
images

इमेज JSON ऑबजेक्ट्स की शृंखला।

limit

limit वस्तुतः परिणाम सृजित करते समय इस्तेमाल होता है।

offset

offset वस्तुतः परिणाम सृजित करते समय इस्तेमाल होता है।

इसे आज़माएं

यूज़रनेम = API आईडी, पासवर्ड = API सीक्रेट

cURL

$ curl "https://clippingmagic.com/api/v1/images?limit=2&offset=0" \
 -u 123:[secret]

उदाहरण प्रत्युत्तर

{
  "images" : [ {
    "id" : 2346,
    "secret" : "image_secret1",
    "resultRevision" : 0,
    "originalFilename" : "example_image1.jpg",
    "imageCategoryUser" : "Photo",
    "imageCategoryAi" : "Photo",
    "test" : false
  }, {
    "id" : 2347,
    "secret" : "image_secret2",
    "resultRevision" : 0,
    "originalFilename" : "example_image2.jpg",
    "imageCategoryUser" : "Photo",
    "imageCategoryAi" : "Photo",
    "test" : false
  } ],
  "limit" : 2,
  "offset" : 0
}

डिलीट करें POST https://clippingmagic.com/api/v1/images/[imageId]/delete

इमेज हटाने के लिए, आप इसके हटाएं-URL पर मानक HTTP POST करें।

यह वास्तविकता का सामना करने के लिए मानक REST अभ्यास से मामूली विचलन है कि एक ही काम करने के कई तरीकों से होने वाली गड़बड़ी से बचते हुए, बहुत सारी HTTP क्लायंट लाइब्रेरियाँ HTTP DELETE क्रिया का समर्थन नहीं करती हैं।

पैरामीटर्स
imageId

URL में समाहित किया गया

आपको वह id मान डालने की जरूरत होगी जो कि अपलोड कॉल में वापस किया गया था।

प्रत्युत्तर विशेषताएं
image

हटाई गई इमेज JSON ऑबजेक्ट।

इसे आज़माएं

यूज़रनेम = API आईडी, पासवर्ड = API सीक्रेट

cURL

$ curl "https://clippingmagic.com/api/v1/images/2346/delete" \
 -u 123:[secret] \ 
 -X POST

उदाहरण प्रत्युत्तर

{
  "image" : {
    "id" : 2346,
    "secret" : "image_secret1",
    "resultRevision" : 0,
    "originalFilename" : "example_image1.jpg",
    "imageCategoryUser" : "Photo",
    "imageCategoryAi" : "Photo",
    "test" : false
  }
}

अकाउंट GET https://clippingmagic.com/api/v1/account

आपके अकाउंट की मूलभूत जानकारी जैसे आपकी सदस्यता स्थिति और शेष क्रेडिट्स प्राप्त करें।

पैरामीटर्स
कुछ भी नहीं

प्रत्युत्तर विशेषताएं
subscriptionPlan

आपके द्वारा वर्तमान में ली गई सदस्यता योजना, या 'कुछ भी नहीं'।

subscriptionState

आपकी वर्तमान सदस्यता की स्थिति ('सक्रिय' या 'पिछला बकाया') या यदि सदस्यता नहीं ली गई हो तो 'समाप्त'।

credits

आपके अकाउंट में शेष API क्रेडिट की संख्या। अगर इस समय सदस्यता नहीं है तो 0, या किसी गैर-API प्लान की सदस्यता ली है।

इसे आज़माएं

यूज़रनेम = API आईडी, पासवर्ड = API सीक्रेट

cURL

$ curl "https://clippingmagic.com/api/v1/account" \
 -u 123:[secret]

उदाहरण प्रत्युत्तर

{
  "subscriptionPlan" : "none",
  "subscriptionState" : "ended",
  "credits" : 0
}