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 সার্ভার একটি সেকেন্ডে দশটি প্রশ্নে সীমাবদ্ধ।