एपीआई और वेबहुक
इनवॉइस, रिसिप्ट और अन्य व्यापारिक दस्तावेजों को अपलोड और पढ़ने के लिए REST एपीआई उपलब्ध है। खाता, फ़ोल्डर, लेबल और कनेक्शन का प्रबंधन ऐप में ही रहता है।
कुंजी
यह सेटिंग → डेवलपर्स के तहत स्थापित की जाती है। कुंजी एक बार दिखाई देती है, स्थापना के समय — फिर कभी नहीं, क्योंकि केवल उसका हैश संग्रहीत किया जाता है। खोई हुई कुंजी को फिर से प्राप्त नहीं किया जा सकता, एक नई स्थापित की जाती है और पुरानी हटा दी जाती है। अधिकतम पांच कुंजी रखी जा सकती हैं, प्रत्येक के पास दो वर्षों तक वैकल्पिक वैधता हो सकती है।
कुंजी को X-API-Key हेडर में भेजा जाता है।
एपीआई की क्षमताएँ
| ऑपरेशन | विवरण |
|---|---|
POST /api/upload | फ़ाइल अपलोड करना, विकल्प: प्रारूप, दिशा, प्रकार, मुद्रा, योजना, फ़ोल्डर, वेबहुक |
POST /api/upload/url | सार्वजनिक पते से वही करें; हम फ़ाइल को स्वयं डाउनलोड कर लेंगे |
GET /api/jobs | फ़िल्टर और पृष्ठन के साथ दस्तावेज़ों की सूची |
GET /api/jobs/{id} | स्थिति, पढ़ी गई डेटा, खोजें और लक्ष्य प्रारूप में परिणाम |
GET /api/jobs/{id}/original | अपलोड की गई फ़ाइल |
DELETE /api/jobs/{id} | रद्द करना |
एक्सेल और पीडीएफ परिणाम में Base64 के रूप में आते हैं। जो परिणाम की आवश्यकता नहीं है, वह includeResult=false भेज सकता है, इससे सर्वर पर रूपांतरण की बचत होती है।
OpenAPI प्रारूप में इंटरफ़ेस का विवरण /api/docs पर है; लिंक सेटिंग में कुंजियों के पास है। विवरण वर्तमान कोड से उत्पन्न होता है, इसलिए यह उसी के अनुरूप होता है जो एपीआई करता है।
एपीआई से दस्तावेज़ों की जांच
भेजने से पहले की जांच डिफ़ॉल्ट रूप से कुंजी द्वारा अपलोड किए गए दस्तावेज़ों के लिए भी मान्य है: दस्तावेज़ पुष्टि के लिए ऐप में उपस्थित रहता है और वेबहुक उसके बाद ही भेजा जाता है। जो एकीकरण बना रहा है, जिसमें कोई स्क्रीन पर नहीं है, वह सेटिंग्स → भेजने से पहले की जांच में एपीआई चैनल हटा सकता है, या जांच को बंद कर सकता है।
MCP
AI एजेंटों के लिए /api/mcp पर वही कुंजी वाला MCP सर्वर है। यह दस्तावेज़ों को पढ़ और खोज सकता है, अपलोड नहीं कर सकता; अपलोड को एक तैयार आदेश के रूप में लौटाता है, जिसे एजेंट स्वयं चलाता है।
वेबहुक
स्थिति की जांच करने के बजाय, जब कार्य पूर्ण हो जाए, तो परिणाम भेजने के लिए अपने आप को अनुमति दें। पता समग्र खाते के लिए सेटिंग → डेवलपर्स में सेट किया जाता है, या व्यक्तिगत अपलोड के लिए targetWebhookUrl पैरामीटर के द्वारा। सेटिंग में बटन एक परीक्षण संदेश भेजता है।
POST को JSON के साथ भेजा जाता है: दस्तावेज़ का पहचानकर्ता, फ़ाइल का नाम, प्रारूप और लक्ष्य प्रारूप में परिणाम। जब दस्तावेज़ जांच पास करता है या पुनः संसाधित होता है, तो वेबहुक दूसरी बार IsCorrection फ्लैग के साथ आता है।
संदेश पर हस्ताक्षर नहीं किया जाता है। भेजने वाले को सत्यापित करने के लिए, पते में अपना अपना गुप्त टोकन डालें। निजी नेटवर्क के पते स्वीकार नहीं किए जाते हैं।
असफल डिलीवरी को बढ़ती हुई देरी के साथ दोहराया जाएगा, लगभग चार और आधे घंटे में ग्यारह प्रयास। प्रत्येक प्रयास आपकी तरफ से प्रतिक्रिया के साथ गतिविधि में होता है; दस्तावेज़ के साथ सूची में डिलीवरी परिणाम का आइकन होता है।
सीमाएँ
एपीआई के पास प्रति मिनट कॉल की संख्या पर कोई स्वामित्व सीमा नहीं है; अपलोड क्रेडिट, फ़ाइल के आकार के अनुसार टैरिफ और प्रत्येक दस्तावेज़ पर बीस पृष्ठों से सीमित होते हैं। अस्वीकृति 400 त्रुटि के रूप में आएगी जिसमें कोड होगा, जो कारण बताएगा। MCP सर्वर की सीमा प्रति सेकंड दस प्रश्नों पर होती है।