API कुंजियाँ
v1 के सभी एंडपॉइंट्स मेंx-api-key हेडर में API कुंजी ज़रूरी है।
API कुंजियाँ बनाना
- AFKCrypto डैशबोर्ड में साइन‑इन करें
- API Keys सेक्शन पर जाएँ
- “Generate API Key” पर क्लिक करें
- कुंजी को एक वर्णनात्मक नाम दें
- वैकल्पिक: समाप्ति सेट करें (7 दिन, 30 दिन, 90 दिन, 180 दिन, या 1 वर्ष)
- कुंजी तुरंत कॉपी करें — यह दोबारा नहीं दिखाई जाएगी
कुंजी का प्रारूप
- Prefix: त्वरित पहचान के लिए 4‑अक्षरीय पहचानकर्ता
- Random: क्रिप्टोग्राफ़िकली सुरक्षित 32‑अक्षरीय रैंडम स्ट्रिंग
API कुंजियों का उपयोग
हर अनुरोध मेंx-api-key हेडर में कुंजी भेजें:
सुरक्षा सर्वोत्तम प्रथाएँ
- 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 कुंजियाँ रद्द करना
डैशबोर्ड से तुरंत कुंजी रद्द करें:- API Keys खोलें
- रद्द करने हेतु कुंजी खोजें
- “Revoke Key” पर क्लिक करें
- कार्रवाई की पुष्टि करें