मुख्य कंटेंट तक स्किप करें

API अवलोकन

ArchiCore REST API आपको अपने वर्कफ़्लो में आर्किटेक्चर विश्लेषण को एकीकृत करने की अनुमति देता है।

बेस URL​

https://api.archicore.io/api/v1

प्रमाणीकरण​

सभी API अनुरोधों के लिए Bearer टोकन का उपयोग करके प्रमाणीकरण आवश्यक है:

curl -H "Authorization: Bearer आपकी_API_कुंजी" \
  https://api.archicore.io/api/v1/projects

API कुंजी प्राप्त करने के विवरण के लिए प्रमाणीकरण देखें।

प्रतिक्रिया प्रारूप​

सभी प्रतिक्रियाएं JSON हैं:

{
  "success": true,
  "data": { ... }
}

त्रुटि प्रतिक्रियाएं:

{
  "success": false,
  "error": "त्रुटि संदेश",
  "code": "त्रुटि_कोड"
}

HTTP स्थिति कोड​

कोडविवरण
200सफलता
201बनाया गया
400गलत अनुरोध - अमान्य पैरामीटर
401अनधिकृत - अमान्य या गायब टोकन
403निषिद्ध - अपर्याप्त अनुमतियां
404नहीं मिला
429बहुत अधिक अनुरोध - दर सीमा पार
500आंतरिक सर्वर त्रुटि

दर सीमाएं​

स्तरअनुरोध/दिनअनुरोध/मिनट
मुफ्त10010
Pro10,000100
Enterpriseअसीमित1,000

दर सीमा हेडर सभी प्रतिक्रियाओं में शामिल हैं:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1640000000

एंडपॉइंट सारांश​

प्रोजेक्ट​

मेथडएंडपॉइंटविवरण
GET/projectsसभी प्रोजेक्ट सूचीबद्ध करें
POST/projectsप्रोजेक्ट बनाएं
GET/projects/:idप्रोजेक्ट विवरण प्राप्त करें
DELETE/projects/:idप्रोजेक्ट हटाएं
POST/projects/:id/indexइंडेक्सिंग शुरू करें

विश्लेषण​

मेथडएंडपॉइंटविवरण
POST/projects/:id/searchसिमेंटिक खोज
POST/projects/:id/askAI असिस्टेंट से पूछें
GET/projects/:id/metricsकोड मेट्रिक्स प्राप्त करें
GET/projects/:id/securityसुरक्षा स्कैन परिणाम
POST/projects/:id/analyzeप्रभाव विश्लेषण

Webhooks​

मेथडएंडपॉइंटविवरण
GET/webhooksWebhooks सूचीबद्ध करें
POST/webhooksWebhook बनाएं
DELETE/webhooks/:idWebhook हटाएं

SDK​

आधिकारिक SDK उपलब्ध हैं:

  • JavaScript/TypeScript: npm install @archicore/sdk
  • Python: pip install archicore

त्वरित उदाहरण​

import { ArchiCore } from '@archicore/sdk';

const client = new ArchiCore({ apiKey: 'आपकी_API_कुंजी' });

// कोड खोजें
const results = await client.projects.search('project-id', {
  query: 'प्रमाणीकरण लॉजिक'
});

// AI से पूछें
const answer = await client.projects.ask('project-id', {
  question: 'प्रमाणीकरण प्रणाली कैसे काम करती है?'
});