सभी गाइड

टीम और प्रशासन

API एंडपॉइंट

प्रोग्राम, स्क्रिप्ट और ऑटोमेशन से किसी गुप्त URL पर दस्तावेज़ भिजवाएँ और उन्हें प्रिंट करें।

API एंडपॉइंट एक गुप्त URL है जिस पर प्रोग्राम दस्तावेज़ भेजते हैं, उदाहरण के लिए किसी ERP सिस्टम से इनवॉइस, किसी ऑनलाइन शॉप से लेबल या किसी स्क्रिप्ट से रिपोर्ट। हर दस्तावेज़ एंडपॉइंट बनाने वाले व्यक्ति की ओर से एक जॉब बनता है और एंडपॉइंट के गंतव्य पर जाता है। URL स्वयं एक्सेस कुंजी है, इसलिए API टोकन की आवश्यकता नहीं होती। API संदर्भ हर विकल्प का वर्णन करता है।

पूर्वापेक्षाएँ

  • सेटिंग्स → इनबाउंड चैनल में इनबाउंड चैनल REST API चालू होना चाहिए। नए संगठनों में यह चालू होता है; पुराने संगठनों में किसी एडमिन को इसे चालू करना पड़ सकता है।
  • हर सदस्य API एंडपॉइंट बना सकता है। उपयोगकर्ता अपने एंडपॉइंट देखते हैं, एडमिन संगठन के सभी एंडपॉइंट।
  • हर प्लान में शामिल।

एक बार का सेटअप

  1. स्रोत → API एंडपॉइंट पर जाएँ और नया API एंडपॉइंट चुनें।
  2. एक नाम दर्ज करें जो बताए कि एंडपॉइंट किस काम के लिए है, उदाहरण के लिए "ERP इनवॉइस"।
  3. उन दस्तावेज़ों के लिए लक्ष्य चुनें जिनके अनुरोध में कोई लक्ष्य नहीं है: कोई गंतव्य, समूह या वर्कफ़्लो, डिफ़ॉल्ट लक्ष्य, या कोई लक्ष्य नहीं – Sealed Print में रखें।
  4. बनाएँ चुनें और एंडपॉइंट URL को अपने प्रोग्राम में कॉपी करें।

दस्तावेज़ को उपयुक्त Content-Type के साथ अनुरोध के बॉडी के रूप में भेजें:

curl -X POST "https://www.sealedprint.com/api/print/sp_ep_…?name=Invoice" \
  -H "Content-Type: application/pdf" \
  --data-binary @invoice.pdf

या फ़ील्ड file वाले फ़ॉर्म के रूप में; विकल्प फ़ॉर्म फ़ील्ड के रूप में साथ जाते हैं:

curl -X POST "https://www.sealedprint.com/api/print/sp_ep_…" \
  -F "file=@invoice.pdf" \
  -F "name=Invoice" \
  -F "copies=2"

targets किसी एक अनुरोध को पहचानकर्ता के ज़रिए कहीं और भेजता है: गंतव्यों, समूहों या किसी वर्कफ़्लो के पहचानकर्ता, अल्पविराम से अलग, उदाहरण के लिए targets=office,warehouse (वर्कफ़्लो सबसे पहले आता है)। destinationId, destinationIds, groupId या workflowId यही काम ID से करते हैं, और noTarget=true (या targets=hold) दस्तावेज़ को Sealed Print में रखता है। ये एक अनुरोध के लिए एंडपॉइंट के लक्ष्य को बदल देते हैं; copies या sides जैसे प्रिंट विकल्प क्वेरी पैरामीटर या फ़ॉर्म फ़ील्ड के रूप में साथ जाते हैं। उत्तर जॉब होता है (HTTP 201)।

हर बार

  • एंडपॉइंट पर अंतिम उपयोग दिखाता है कि कोई प्रोग्राम अभी भी दस्तावेज़ भेज रहा है या नहीं।
  • संपादित करें नाम और लक्ष्य बदलता है; URL वही रहता है।
  • नया URL बनाएँ URL को बदल देता है; पुराना तुरंत काम करना बंद कर देता है। हटाएँ एंडपॉइंट को स्थायी रूप से समाप्त करता है।
  • अपने प्रोग्राम से किसी जॉब की स्थिति पर नज़र रखने के लिए, एक API टोकन का उपयोग करें।

समस्या निवारण

  • HTTP 403: इनबाउंड चैनल REST API बंद है, या एंडपॉइंट बनाने वाला व्यक्ति संगठन छोड़ चुका है। किसी दूसरे सदस्य के साथ नया एंडपॉइंट बनाएँ।
  • HTTP 404: URL गलत है या उसे नए URL से बदल दिया गया है। कोड unknown_target के साथ, targets में कोई पहचानकर्ता मौजूद नहीं है या ऐसे गंतव्य का है जिस पर एंडपॉइंट का स्वामी प्रिंट नहीं कर सकता।
  • HTTP 413 या 415: फ़ाइल प्लान की अनुमति से बड़ी है, या PDF, JPEG या PNG नहीं है।
  • URL किसी ऐसी जगह कॉपी हो गया जहाँ उसे नहीं होना चाहिए: तुरंत नया URL बनाएँ चुनें।

आगे क्या