मुख्य सामग्री पर जाएं

​
API कुंजियाँ

v1 के सभी एंडपॉइंट्स में x-api-key हेडर में API कुंजी ज़रूरी है।

​
API कुंजियाँ बनाना

  1. AFKCrypto डैशबोर्ड में साइन‑इन करें
  2. API Keys सेक्शन पर जाएँ
  3. “Generate API Key” पर क्लिक करें
  4. कुंजी को एक वर्णनात्मक नाम दें
  5. वैकल्पिक: समाप्ति सेट करें (7 दिन, 30 दिन, 90 दिन, 180 दिन, या 1 वर्ष)
  6. कुंजी तुरंत कॉपी करें — यह दोबारा नहीं दिखाई जाएगी

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

afk_<prefix>_<random>

उदाहरण: afk_xY3z_Ab12cD34Ef56Gh78Ij90Kl12Mn34Op56
  • Prefix: त्वरित पहचान के लिए 4‑अक्षरीय पहचानकर्ता
  • Random: क्रिप्टोग्राफ़िकली सुरक्षित 32‑अक्षरीय रैंडम स्ट्रिंग

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

हर अनुरोध में x-api-key हेडर में कुंजी भेजें: 
curl -X GET https://api.afkcrypto.com/api/v1/wallets \
  -H "x-api-key: afk_xY3z_Ab12cD34Ef56Gh78Ij90Kl12Mn34Op56"

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

  • API कुंजियों को कभी भी वर्शन कंट्रोल में कमिट न करें — वातावरण चर का उपयोग करें
  • कुंजियों को नियमित रूप से रोटेट करें — अस्थायी एक्सेस के लिए समाप्ति सेट करें
  • प्रत्येक वातावरण के लिए अलग कुंजियाँ रखें — dev, staging, production
  • अनुपयोगी कुंजियों को तुरंत रद्द करें — अटैक सरफ़ेस घटाएँ
  • सुरक्षित भंडारण — सीक्रेट मैनेजर का उपयोग करें (जैसे AWS Secrets Manager, HashiCorp Vault)

​
कुंजी की समाप्ति

API कुंजियाँ निर्धारित अवधि के बाद वैकल्पिक रूप से समाप्त हो सकती हैं:
  • कभी समाप्त नहीं होती (डिफ़ॉल्ट): रद्द होने तक काम करती है
  • 7 दिन: अल्पकालिक परीक्षण/डेमो
  • 30 दिन: ठेकेदार एक्सेस या ट्रायल
  • 90 दिन: त्रैमासिक रोटेशन की सिफारिश
  • 180 दिन: अर्धवार्षिक रोटेशन
  • 1 वर्ष: स्थिर इंटीग्रेशन के लिए वार्षिक रोटेशन
कुंजी समाप्त होने पर क्या होता है?
  • उस कुंजी के साथ की गई सभी रिक्वेस्ट HTTP 401 UNAUTHORIZED लौटाएंगी
  • कुंजी ऑडिट प्रयोजनों के लिए डैशबोर्ड में दिखाई देती रहेगी
  • प्रतिस्थापन के लिए नई कुंजी बनाएँ
समाप्ति की निगरानी
  • डैशबोर्ड में “Expired” या “Expiring soon” (≤ 7 दिन) दिखेगा
  • रुकावट से बचने के लिए अलर्ट सेट करें

​
कुंजी सीमाएँ

  • अधिकतम सक्रिय कुंजियाँ: प्रति उपयोगकर्ता 10
  • रेट लिमिट लागू होती हैं — देखें Rate limiting
  • सीमा में रहने के लिए अनुपयोगी कुंजियाँ रद्द करें

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

डैशबोर्ड से तुरंत कुंजी रद्द करें:
  1. API Keys खोलें
  2. रद्द करने हेतु कुंजी खोजें
  3. “Revoke Key” पर क्लिक करें
  4. कार्रवाई की पुष्टि करें
ध्यान दें: रद्दीकरण स्थायी है और तुरंत प्रभावी होता है।

​
संबंधित

API संदर्भ

नीतियाँ और सुरक्षा

समर्थित चेन