प्लेटफ़ॉर्म अवलोकन
OmniDoc API एक ही खाते के भीतर फ़ाइल और सामग्री वर्कफ़्लो की सेवा प्रदान करता है। कॉलर एक API कुंजी के साथ संसाधन बनाता है, और फिर उन्हें क्वेरी करने, जोड़ने, प्रोसेस करने या डाउनलोड करने के लिए उसे वापस मिलने वाले स्थिर ID का उपयोग करता है।
संसाधन मॉडल
Section titled “संसाधन मॉडल”| संसाधन | उद्देश्य |
|---|---|
| दस्तावेज़ / फ़ाइल | खाते के स्वामित्व वाली स्रोत फ़ाइलें और फ़ाइल लाइब्रेरी प्रविष्टियाँ |
| नौकरी / परिचालन | असिंक्रोनस अनुवाद, दस्तावेज़ प्रसंस्करण या ऑडियो और वीडियो कार्य |
| आर्टिफैक्ट | परिणाम जो कोई नौकरी प्रीव्यू या डाउनलोड के लिए देती है |
| क्रेडिट संचालन | एक बिलेबल कार्रवाई के लिए जो शुल्क लगाया गया और वापस किया गया, उसका रिकॉर्ड |
प्रत्येक संसाधन को स्वामी खाते के साथ जांचा जाता है। ग्राहकों को केवल सार्वजनिक आईडी रखने की आवश्यकता होती है, और उन्हें आईडी, फ़ाइल नाम या डाउनलोड पतों से कार्यान्वयन विवरण का अनुमान नहीं लगाना चाहिए।
सामान्य कॉल फ़्लो
Section titled “सामान्य कॉल फ़्लो”- एक इनपुट संसाधन बनाएँ या चुनें।
- सुनिश्चित करें कि खाते में क्रेडिट हो: जॉब शुरू होने से पहले बैलेंस की जाँच एक थ्रेशोल्ड के खिलाफ की जाती है, और वास्तविक उपयोग का शुल्क इसके समाप्त होने पर लगाया जाता है।
- एक
Idempotency-Keyके साथ जॉब बनाएं। - नौकरी की स्थिति जांचें; फ़ाइल अनुवाद नौकरियों में SSE या वेबहुक भी उपयोग किए जा सकते हैं।
- इस कार्य के परिणाम और क्रेडिट रिकॉर्ड पढ़ें।
बाहरी एकीकरण हमेशा API कुंजियों का उपयोग करते हैं, जिनके पास उस खाते के समान अनुमतियाँ होती हैं जिसने कुंजी बनाई है। प्रमाणीकरण देखें।
त्वरित प्रारंभ → फ़ाइल अपलोड करें, जॉब बनाएं, उसकी स्थिति जांचें और परिणाम डाउनलोड करें