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