API மற்றும் webhook கள்
REST API மூலம் ஆவணங்களை பதிவேற்றவும் வாசிக்கவும் கிடைக்கிறது. கணக்குப் பராமரிப்பு, ஷேனோன்கள், உருப்படிகள் மற்றும் தொடர்புகள் பயன்பாட்டில் இருந்து தொடர்கிறது.
விசை
இது அமைப்புகள் → வளர்த்துநர் என்பதில் உருவாக்கப்படுகிறது. விசை ஒன்றே einmal, உருவாக்கும் போது தோன்றும் — பிறகு இல்லை, ஏனெனில் இதன் அச்சு மட்டுமே சேமிக்கப்படுகிறது. இழந்த விசை மீண்டும் பெறப்படாது, புதிய ஒன்று உருவாக்கப்படுகிறது மற்றும் பழையை சொdeleteகு. விசைகளை ஐந்து விழுப்படிகள் கொண்டிருக்க வேண்டும், ஒவ்வொன்றும் இரண்டு ஆண்டுகருவியுடன்.
விசை X-API-Key என்ற தலைப்பில் அனுப்பப்படுகிறது.
API யின் திறன்கள்
| செயல்பாடு | விளக்கம் |
|---|---|
POST /api/upload | கோப்பின் பதிவேற்றம் விருப்பங்களை உட்படுத்துகிறது: வடிவம், திசை, வகை, நாணயம், மாதிரி, ஷேனோன், webhook |
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 அனுப்புகிறார், அதன் மூலம் server இல் மாற்றங்களைச் சேமிக்கிறார்.
OpenAPI வடிவத்தில் உள்ள இடைமுக விவரம் /api/docs முகவரியில் உள்ளது; இது முன்னிலை பட்டியில் காணப்படுகிறது. விவரம் இயங்கும் குறியீட்டிலிருந்து உருவாக்கப்படுகிறது, எனவே API என்ன செய்கிறது என்பதற்கு அடிப்படையாகவே இருக்கும்.
API ஆவணங்களில் சரிபார்ப்பு
அனுப்புவதற்கு முன்பான சரிபார்ப்பு, விசையால் பதிவேற்றப்பட்ட ஆவணங்களுக்கு இயல்புப் பாகமாகவே நடைமுறை பெற்றுள்ளது: ஆவணம் confirm செய்ய பயன்பாட்டில் காத்திருக்கிறது மற்றும் webhook அதற்கு பிறகு விடப்படுகிறது. யாரும் திரை முத்திரையை அருகில் வைக்காமல் ஒருங்கிணைப்பை உருவாக்குவதற்கானவர்கள் அமைப்புகள் → அனுப்புவதற்கு முன்னணி சரிபார்ச்சிக்கான API சேனல் நீக்குவது அல்லது சரிபார்ப்பை முடக்குவது.
MCP
AI முகவரிகளுக்காக /api/mcp முகவரியில் MCP சர்வர் சம சாஃபுக்காக உள்ளது. இது ஆவணங்களை வாசிக்க மற்றும் தேடுவதில் திறமை கொண்டது, பதிவேற்ற யோசிகையோடு இல்லை; பதிவேற்றத்தின் முடிவை உருவாக்கும் கட்டளை போலவே இது எளிமையாக உருவாக்கப்படுகிறது.
Webhook கள்
நிலை பரிசோதிப்பதற்குப் பதிலாக, முடிவைப் அனுப்புங்கள், அது முடிவடையும் போது. முகவரி முழு கணக்கிற்காக அமைப்புகள் → வளர்த்துநர் என்பதில் அமைக்கப்படுகிறது, அல்லது தனித்தனியே பதிவேற்றத்திற்கு targetWebhookUrl என்ற அளவுருவால் அமைக்கப்படுகிறது. அமைப்பில் உள்ள திறப்புப்பெட்டி சோதனை செய்தியை அனுப்புகிறது.
POST ஒரு JSON-ஐ அனுப்புகிறது: ஆவணத்தின் அடையாளம், கோப்பின் பெயர், வடிவம் மற்றும் இலக்கு வடிவத்தில் முடிவு. உருப்பாடு சரிபார்ப்பை கடந்தால் அல்லது மறுபடியும் செயலாக்கப்பட்டால், மறுபடியும் webhook IsCorrection என்ற கொடியுடன் வந்தது.
செய்தி கையொப்பமாகப் பதிவிடாது. உங்கள் தனிப்பட்ட ரகசிய டோக்கனை முகவரியில் சேர்க்கவும். தனியார் நெட்வொர்க்குகளுக்கான முகவரிகள் தடுப்பிக்கப்படுகின்றன.
அதிரடித் துவக்கம் சிலரால் மீண்டும் செயலாக்கப்படுகிறது மற்றும் 400 கோப்பு தூக்கத்தில் தோன்றுகிறது, ஒருநாள் மூன்று மற்றும் பாதி மணியில் 11 முயற்சிகள் வருகிறார்கள். ஒவ்வொரு முயற்சியும் உங்கள் பக்கம் பதிலுடன் செயலியலில் உள்ளது; ஆவணத்தில் விவரக்குறிப்பில் முடிவாக்க அடிப்படையுடன் உள்ள சின்னம்தேவி.
எல்லைகள்
API-க்கு நிமிடத்தில் அழைப்புகளின் எண்ணிக்கைக்கான தனியார் உச்சம் இல்லை; பதிவேற்றங்கள் கிரெடிடுகளை நிலைத்துவைக்கின்றன, கோப்பின் அளவு கட்டணத்திற்கு ஏற்ப மற்றும் ஆவணத்திற்கு இருபது பக்கம். மறுப்பதற்கு 400 தவறு மற்றும் அதற்கான குறியீட்டில் வருகை அளிக்கப்படுகிறது. MCP சர்வர் இரு வினாடிக்குள் பதில்கள் 10 கேள்விகளுக்கு கீழுது.