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/docs वर आहे; कळ्या सेटिंग्जमध्ये दुव्यावर आहे. वर्णन चालू कोडमधून तयार केले जाते, त्यामुळे ते API काय करते त्यास अनुरूप आहे.
API कडून कागदपत्रांची पडताळणी
प्रसंग पाठवण्यापूर्वी पडताळणी कुशलतेने कागदपत्रांसाठीही लागू आहे: कागदपत्र अनुप्रयोगात पुष्टीसाठी अपेक्षित आहे आणि वेबहुक त्यानंतरच जाईल. जो एकात्मता तयार करत आहे, जो कोणी स्क्रीनवर बसलेला नाही त्यांनी सेटिंग्ज → पाठवण्यापूर्वी पडताळणीमध्ये API चा चॅनेल काढून टाका किंवा पडताळणी बंद करा.
MCP
AI एजंटसाठी /api/mcp पत्त्यावर MCP सर्व्हर आहे, ज्याबरोबरच तीच की आहे. हे कागदपत्र वाचू शकते आणि शोधू शकते, अपलोड करू शकत नाही; अपलोड एक पूर्ण आदेश म्हणून परत करेल, जो एजंट स्वतः चालवतो.
वेबहुक
स्थितीची चौकशी करण्यात येण्याच्या ऐवजी, तुम्हाला परिणामी पाठवले जाईल, जेव्हा ते तयार असेल. पत्ता संपूर्ण खात्यासाठी सेटिंग्ज → विकासकांसाठी येथे सेट केला जातो, किंवा स्वतंत्र अपलोडसाठी targetWebhookUrl परिमाणाद्वारे सेट केला जातो. सेटिंग्जमधील बटण चाचणी संदेश पाठवेल.
POST म्हणजे JSON सह पाठवले जाईल: कागदपत्रांचे ओळखपत्र, फाइलचे नाव, फॉरमॅट आणि अंतिम फॉरमॅटमध्ये निकाल. जेव्हा कागदपत्र पडताळणी पास करते किंवा पुनर्प्रक्रिया केले जाते, तेव्हा वेबहुक दुसऱ्यांदा सुधारणा फ्लॅगसह (IsCorrection) येईल.
संदेशावर स्वाक्षरी केलेली नाही. पाठवणारे ओळखा तुम्ही स्वतःच्या पर्सनल टोकनसह पत्त्यात समाविष्ट करून. खाजगी नेटवर्क्समध्ये पत्ते नाकारले जातात.
जेव्हा वेबहुक सर्व प्रयत्नांनंतरही पोहोचत नाही, तर साधारणपणे चार व अर्धा तासांनंतर ई-मेल येईल. एका व्यत्ययादरम्यान एकदाच, पुढील अपयश क्रियाकलापात असतील. जर वेबहुकची पत्ता बदलली जाईल, तर आपल्याबद्दल न झालेल्या कोणीतरी बदलली असेल, तर ई-मेल येईल.
अयशस्वी वितरण वाढत असलेल्या विलंबासह पुनरावृत्ती होते, साधारणपणे चार आणि अर्धा तासांमध्ये ऐंशी प्रयत्न. प्रत्येक प्रयत्न क्रियाकलापामध्ये तुमच्या प्रतिसादासह आहे; कागदपत्राच्या यादीमध्ये वितरणाच्या निकालासह आयकॉन आहे.
मर्यादा
API कडे एका मिनिटात कॉलची स्वतःची मर्यादा नाही; अपलोड क्रेडिट्स, फाइलचा आकार टारिफनुसार आणि कागदपत्रावर वीस पृष्ठांमुळे मर्यादित आहे. नकार 400 त्रुटी म्हणून येतो ज्यात कोड असतो, जो का सांगतो. MCP सर्व्हर प्रति सेकंदात दहा प्रश्नांवर मर्यादित आहे.