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

होस्ट किया गया स्मार्ट संपादक

अपने कस्टम वर्कफ़्लो में क्लिपिंग मैजिक एडिटर को एकीकृत करने का सबसे आसान तरीका।

एकीकरण चरण

तेज़ी से शुरुआत को पहले पढ़ना याद रखें।

  1. सर्वर API का इस्तेमाल करके एक इमेज अपलोड करें।

  2. एक होस्ट किया गया स्मार्ट संपादक URL बनाएं और अपने मानव ऑपरेटर को इसमें भेजें, जहाँ वे आपके द्वारा निर्दिष्ट इमेजिस को क्लिप करते हैं।

  3. सभी इमेजिस को क्लिप करने के बाद, आपके मानव ऑपरेटर का ब्राउजर निर्दिष्ट वापसी URL के साथ एक HTTP POST के साथ जुड़ जाता है जिसमें क्लिपिंग सत्र के बारे में प्रासंगिक जानकारी शामिल होती है।

यदि आपको एक व्हाइट लेबल समाधान या प्रत्येक इमेज के लिए एक कॉलबैक की आवश्यकता है, तो कृपया व्हाइट लेबल स्मार्ट संपादक देखें।

होस्ट किया गया स्मार्ट संपादक URL https://clippingmagic.com/api/v1/hosted/[apiId]

आप एक आसान URL बना सकते हैं और अपने मानव ऑपरेटर को उनके ब्राउज़र में खोल सकते हैं ताकि वे आपकी समीक्षा कर सकें और आपकी एक या अधिक इमेजिस को संपादित कर सकें।

होस्ट किया गया स्मार्ट संपादक URL फंक्शन निम्नलिखित मापदंडों का समर्थन करता है:

images
id1:secret1,id2:secret2,...
123:abc,456:def
आवश्यक

क्लिप करने के लिए इमेजिस। id:secret पेयर्स की एक कौमा द्वारा अलग की गई सूची। आप सर्वर API का इस्तेमाल करके एक इमेज अपलोड करके यह प्राप्त करते हैं।

returnUrl
स्ट्रिंग
आवश्यक

जब आपके मानव ऑपरेटर ने क्लिपिंग समाप्त कर दी है, तो उनका ब्राउज़र इस URL पर एक HTTP POST जारी करेगा। विवरणों के लिए नीचे देखें।

useStickySettings
बूलियन
true, false

यदि आप useStickySettings=true से गुजरते हैं, तो संपादक उस उपयोगकर्ता के लिए वर्तमान में कॉन्फ़िगर की गई स्टिकी सेटिंग्स का इस्तेमाल करेगा जिसकी API कुंजी का उपयोग इमेज अपलोड करने के लिए किया गया था।

यह आपको एक बार मूलभूत क्लिपिंग सेटिंग्स को कॉन्फिगर करने देता है, और फिर उन्हें आपके द्वारा संपादित सभी इमेजेस पर लागू करता है।

Read about how to configure the sticky settings

API के माध्यम से प्री-क्रॉप उपलब्ध नहीं है, परंतु आप API अपलोड कॉल में इमेज आकार सीमा कॉन्फिगर कर सकते हैं।

डिफ़ॉल्ट: false

hideBottomToolbar
बूलियन
true, false

नीचे वाला टूलबार छुपा देता है, जिससे संपादक को वे सेटिंग्स अनुपलब्ध हो जाती हैं।

डिफ़ॉल्ट: false

locale
स्ट्रिंग

संपादक में इस्तेमाल करने के लिए लिए प्रदर्शन भाषा। यदि छोड़ा जाता है तो डिफॉल्ट रूप से अंग्रेज़ी होती है। मान्य मान निम्नलिखित हैं:

कोडप्रदर्शन भाषा
en-US English (अंग्रेज़ी)
de-DE Deutsch (जर्मन)
es-ES Español (स्पेनी)
fr-FR Français (फ़्रेंच)
hi-IN हिन्दी
id-ID Indonesia (इंडोनेशियाई)
it-IT Italiano (इतालवी)
ja-JP 日本語 (जापानी)
ko-KR 한국어 (कोरियाई)
pl-PL Polski (पोलिश)
pt-BR Português (पुर्तगाली)
ru-RU Русский (रूसी)
th-TH ไทย (थाई)
tr-TR Türkçe (तुर्की)
vi-VN Tiếng Việt (वियतनामी)
zh-Hans-CN 简体中文 (चीनी)
zh-Hant-TW 繁體中文 (चीनी)

आधुनिक ब्राउज़र बहुत लंबे URL की अनुमति देते हैं, लेकिन यदि आपको एक सत्र में 30 इमेजिस से अधिक विरासत ब्राउज़र का समर्थन करने और क्लिप करने की आवश्यकता है, तो आप उन्हें डायरेक्ट लिंक का उपयोग करने की बजाय POST में जमा कर सकते हैं।

सिंगल इमेज का URL उदाहरण



https://clippingmagic.com/api/v1/hosted/123?images=2346:image_secret1&returnUrl=https%3A%2F%2Fclippingmagic.com%2Fapi%2FreturnUrlExample

सिंगल इमेज को निर्दिष्ट करते समय संपादक के पास 'स्किप' बटन नहीं होता है और क्लिप के लिए शेष इमेजिस की संख्या नहीं दिखाता है।

मल्टी इमेज का URL उदाहरण



https://clippingmagic.com/api/v1/hosted/123?images=2346:image_secret1,2347:image_secret2&returnUrl=https%3A%2F%2Fclippingmagic.com%2Fapi%2FreturnUrlExample

कई इमेजिस को निर्दिष्ट करते समय संपादक के पास एक 'स्किप' बटन होता है और क्लिप के लिए शेष इमेजिस की संख्या दिखाता है।

वापसी URL

जब आपके मानव ऑपरेटर ने क्लिपिंग समाप्त कर दी है, तो उनका ब्राउज़र आपके द्वारा निर्दिष्ट वापसी URL के लिए एक HTTP POST जारी करेगा। उस POST की बॉडी में एक एकल पैरामीटर होगा:clippingMagicJson जब आप उस पैरामीटर की सामग्री को पार्स करते हैं, तो वे JSON ऑब्जेक्ट के बारे में जानकारी के साथ अनपैक करते हैं कि कौन से इमेजिस क्लिप किए गए थे। आप डाउनलोड सर्वर API का इस्तेमाल करके फिर आप अब उपलब्ध परिणामों को डाउनलोड कर सकते हैं।

event
एनम
editor-exit, error

editor-exit का मतलब है कि क्लिपिंग सत्र सफलतापूर्वक संपन्न हुआ।

error का मतलब है कि एक त्रुटि हुई और नीचे error पोपुलेट किया गया है।

images
[{"id":1,"secret":"secret1"},{"id":2,"secret":"secret2"},{"id":3,"secret":"secret3"},{"id":4,"secret":"secret4"}] 		होस्ट किया गया स्मार्ट संपादक URL में दिए गए चित्रों के साथ एक सारणी।
clipped
[{"id":1,"secret":"secret1"},{"id":2,"secret":"secret2"}] 		इमेजिस के साथ एक सरणी वास्तव में इस सत्र में क्लिप की हुई थी, अर्थात् वे इमेजिस जहां मानव ऑपरेटर ने संपादक में 'हो गया' पर क्लिक किया था।
skipped
[{"id":3,"secret":"secret3"},{"id":4,"secret":"secret4"}] 		स सत्र में इमेजिस के साथ एक सरणी छोड़ दी गई, अर्थात् वे इमेजिस जहां मानव ऑपरेटर ने संपादक में 'छोड़ें' पर क्लिक किया था।

यदि event=error, वहाँ एक error सदस्य वस्तु के साथ पोपुलेट होगी:

error.status
इंटीगर 		HTTP-स्टेट्स-जैसा-कोड। 4xx का मतलब है कॉलर त्रुटि। 5xx का मतलब है एक अंदरूनी सर्वर त्रुटि हुई।
error.code
इंटीगर 		संख्या जो विशिष्ट रूप से हुई त्रुटि को पहचानती है।
error.message
स्ट्रिंग 		मानव-पठनीय एरर संदेश जो होने वाली त्रुटि का विवरण देते हैं।

आपको या तो CSRF चेक को अक्षम करना होगा या POST को सफल होने के लिए CSRF टोकन वापसी URL में जोड़ना होगा।

यदि आपका मानव ऑपरेटर अपने ब्राउज़र को बंद कर देता है या आप एक अप्रकाशित होस्ट किया गया स्मार्ट संपादक URL का उपयोग करते हैं, तो आपका रिटर्न URL कॉल नहीं किया जाएगा।

सफलता के उदाहरण clippingMagicJson इसमें डीकोड करता है: 
{
  "event" : "editor-exit",
  "images" : [ {
    "id" : 2346,
    "secret" : "image_secret1"
  }, {
    "id" : 2347,
    "secret" : "image_secret2"
  } ],
  "clipped" : [ {
    "id" : 2346,
    "secret" : "image_secret1"
  }, {
    "id" : 2347,
    "secret" : "image_secret2"
  } ],
  "skipped" : [ ]
}
अपने रिटर्न URL की जांच करें
त्रुटि के उदाहरण clippingMagicJson इसमें डीकोड करता है: 
{
  "event" : "error",
  "error" : {
    "status" : 400,
    "code" : 1234,
    "message" : "Example error"
  },
  "images" : [ {
    "id" : 2346,
    "secret" : "image_secret1"
  }, {
    "id" : 2347,
    "secret" : "image_secret2"
  } ],
  "clipped" : [ ],
  "skipped" : [ {
    "id" : 2346,
    "secret" : "image_secret1"
  }, {
    "id" : 2347,
    "secret" : "image_secret2"
  } ]
}
अपने रिटर्न URL की जांच करें