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