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-ல் பதிவுகளுக்கான சரிபார்ப்பு
இறுப்புக்களை மாற்றக்கூடிய முன்னணி நிலை, கீ மூலம் பதிவேற்றப்பட்ட பதிவுகள் ஒழுங்குவழிப் பணிகளைச் சேர்க்கிறது: பதிவு பயன்பாட்டில் உறுதிப்படுத்தலுக்காக காத்திருக்கும், மற்றும் வெப் ஹுக் அதன் பிறகு மட்டுமே அனுப்பப்படுகிறது. படத்தைச் சீராக உருவாக்குபவர், யாரேனும் த schermலில் இருக்கவில்லை, அமைப்பால் கொண்டு வரவும் → அனுப்பும் முன் சரிபார்ப்பு மூலம் API சேனலை நீக்கலாம் அல்லது சரிபார்ப்பை முடக்கலாம்.
MCP
AI முகவரிக்கான MCP சேவையகம் /api/mcp என்ற முகவரியில் உள்ளது, அதாவது அதே கீ-ஐப் பயன்படுத்துகிறது. இது பதிவுகளை வாசிக்க மற்றும் தேட கொள்ளலாம், பதிவேற்ற முடியாது; மேலும் பதிவேற்றத்தை முடிவுக்கு அனுப்பும் என்று முகவர் தானாகவே அதை இயக்குவார்.
வெப் ஹுக்
நிலைப்படி சோதிக்கும் போது முடிவுகளை ஒரு இறுப்பு செய்தியைப் பெறவும். முகவரியை ամբողջ கணக்கிற்கு அமைப்பில் அமைக்கலாம் → மேம்படுத்துநர்களுக்கு, அல்லது தனிப்பட்ட பதிவேற்றத்திற்கேற்ற்பதிவில் targetWebhookUrl என்ற மாறி. அமைப்பில் உள்ள பொத்தான் சோதனைச் செய்தியை அனுப்பும்.
POST ஒரு JSON அனுப்பப்படுகிறது: பதிவின் அடையாள எண்ணிக்கை, கோப்பின் பெயர், வடிவம் மற்றும் இலக்கு வடிவத்தில் முடிவு. பதிவு சரிபார்ப்பில் தோன்றியவுடன் அல்லது மீண்டும் செயலாக்கப்பட்டால், வெப் ஹுக் மீண்டும் கடந்து இருப்பு கொள்கிறது (IsCorrection).
செய்தி கையொப்பமிடப்படவில்லை. உங்கள் சொந்த ரகசிய டோக்கனை முகவரியில் உள்ளே சேர்க்கவும். தனியார் நெட்வெற்றிக்கு அனுப்பப்படும் முகவரிகள் மறுக்கப்படும்.
அனைத்துப் முயற்சிகளுக்கும் பிறகு வெப் ஹுக் சென்றால், சுமார் நான்கு மற்றும் அரை மணிநேரத்திற்குப் பிறகு மின்னஞ்சல் வரும். ஒரே முறையில் ஒரு முறை ஒரு கோழியில் , மற்ற துருப்பிடிப்புகள் செயல்பாடு உள்ளன. ஷெட்டில் மாற்ற விதிகளை இயக்கக் கூடாது, ஒரு வேறு காசோலைக்கு மாற்றியிருந்தால்.
அவுட்பூஸில் பிடிக்க முடியாத அனுப்பி மீண்டும் விடுபடும், 11 முயற்சிகள் சுமார் நான்கு மற்றும் அரிசியின் முன்னணி உள்ளது. ஒவ்வொரு முயற்சிக்கும் உங்கள் முன்னணி மதிப்பீடு உள்ளது என்பதற்கான அதிகாரம்; பதிவில் தகவலுக்கான சின்னம் கிடைக்கிறது.
எல்லைகள்
APIக்கு ஒரே நிமிடத்திற்கு அழைப்புகள் என்றே கையெழுத்துப்ப்டிக்கைகள் தனிக்கோப்பில் இல்லை; பதிவேற்றம் கிரெடிட்களுக்கு கண்ணியத்தை குறைத்து, கோப்பின் அளவு தனிப்பட்ட திட்டத்தின் வரம்பை நிச்சயமாகக் கூறுகிறது. துருப்பிடிப்பு 400 பிழை என்ன காரணம் என்பதைக் குறிக்கின்றது. MCP சேவையகம் ஒரு வினாடிக்கு 10 கேள்விகளுக்குள் கட்டுப்படுகிறது.