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

प्रमाणीकरण

ArchiCore प्रमाणीकरण के लिए API कुंजियों का उपयोग करता है।

API कुंजी प्राप्त करना​

  1. ArchiCore में लॉगिन करें
  2. सेटिंग्स → डेवलपर पर जाएं
  3. API कुंजी जनरेट करें पर क्लिक करें
  4. अपनी कुंजी कॉपी करें और सुरक्षित रूप से स्टोर करें
warning

API कुंजियां केवल एक बार दिखाई जाती हैं। इन्हें सुरक्षित रूप से स्टोर करें!

API कुंजी का उपयोग​

Authorization हेडर में कुंजी शामिल करें:

curl -H "Authorization: Bearer sk_live_xxxxx" \
  https://api.archicore.io/api/v1/projects

या क्वेरी पैरामीटर के रूप में (अनुशंसित नहीं):

curl "https://api.archicore.io/api/v1/projects?api_key=sk_live_xxxxx"

कुंजी प्रकार​

प्रीफिक्सप्रकारविवरण
sk_live_प्रोडक्शनआपके खाते तक पूर्ण पहुंच
sk_test_टेस्टविकास के लिए सीमित पहुंच

कुंजी अनुमतियां​

API कुंजियां आपके खाते के स्तर से अनुमतियां प्राप्त करती हैं:

अनुमतिमुफ्तProEnterprise
प्रोजेक्ट पढ़ना✓✓✓
प्रोजेक्ट बनाना✓✓✓
विश्लेषण✓✓✓
Webhooks-✓✓
टीम एक्सेस--✓

कुंजियां रद्द करना​

API कुंजी रद्द करने के लिए:

  1. सेटिंग्स → डेवलपर पर जाएं
  2. सूची में कुंजी खोजें
  3. रद्द करें पर क्लिक करें

रद्द की गई कुंजियां तुरंत काम करना बंद कर देती हैं।

सुरक्षा सर्वोत्तम प्रथाएं​

  1. कभी भी API कुंजियां कमिट न करें वर्जन कंट्रोल में
  2. एनवायरनमेंट वेरिएबल्स का उपयोग करें कुंजियां स्टोर करने के लिए
  3. नियमित रूप से कुंजियां बदलें (अनुशंसित: हर 90 दिन)
  4. डेवलपमेंट के लिए टेस्ट कुंजियों का उपयोग करें
  5. डैशबोर्ड में उपयोग की निगरानी करें

एनवायरनमेंट वेरिएबल्स​

# .env (.gitignore में जोड़ें!)
ARCHICORE_API_KEY=sk_live_xxxxx
const client = new ArchiCore({
  apiKey: process.env.ARCHICORE_API_KEY
});

OAuth (जल्द आ रहा है)​

टीम इंटीग्रेशन के लिए OAuth 2.0 सपोर्ट की योजना है।