ऑथेंटिकेशन का अवलोकन
Caution
डेमो पेज - यह एक डेमो पेज है जो मल्टी-टैब डॉक्यूमेंटेशन सुविधा को दिखाता है. यह सामग्री केवल उदाहरण के तौर पर है.
यह गाइड बताती है कि हमारे API के साथ ऑथेंटिकेशन कैसे करें. हम कई ऑथेंटिकेशन तरीके सपोर्ट करते हैं:
API कीज़
सबसे आसान ऑथेंटिकेशन तरीका API कीज़ का उपयोग करना है. हर API की एक विशिष्ट उपयोगकर्ता से जुड़ी होती है और उसकी अपनी अनुमतियाँ होती हैं.
// Example API Key requestconst response = await fetch('https://api.example.com/data', { headers: { 'Authorization': 'Bearer YOUR_API_KEY' }});OAuth 2.0
अधिक सुरक्षित एप्लिकेशन के लिए, हम OAuth 2.0 ऑथेंटिकेशन फ़्लो सपोर्ट करते हैं:
- ऑथराइज़ेशन अनुरोध: उपयोगकर्ताओं को हमारे ऑथराइज़ेशन URL पर रीडायरेक्ट करें
- उपयोगकर्ता की सहमति: उपयोगकर्ता अपने अकाउंट तक पहुँच को मंज़ूरी देता है
- ऑथराइज़ेशन कोड: हमारा सर्वर एक ऑथराइज़ेशन कोड लौटाता है
- टोकन एक्सचेंज: कोड को एक्सेस टोकन से बदलें
- API अनुरोध: सुरक्षित संसाधनों तक पहुँचने के लिए एक्सेस टोकन का उपयोग करें
JWT टोकन
ऑथेंटिकेशन के बाद, हम JWT टोकन जारी करते हैं जिनमें उपयोगकर्ता और उसकी अनुमतियों की एन्कोड की गई जानकारी होती है.
// Example JWT token usageconst response = await fetch('https://api.example.com/protected-resource', { headers: { 'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...' }});सेशन प्रबंधन
सेशन डिफ़ॉल्ट रूप से 24 घंटे तक मान्य रहते हैं. सेशन को रिफ़्रेश करने के लिए:
const refreshResponse = await fetch('https://api.example.com/auth/refresh', { method: 'POST', headers: { 'Content-Type': 'application/json', 'Authorization': 'Bearer CURRENT_REFRESH_TOKEN' }});
// Parse the new tokensconst { accessToken, refreshToken } = await refreshResponse.json();सर्वोत्तम तरीके
- API कीज़ या टोकन को कभी भी क्लाइंट-साइड कोड में स्टोर न करें
- संवेदनशील क्रेडेंशियल्स के लिए एनवायरनमेंट वेरिएबल्स का उपयोग करें
- लंबे समय तक चलने वाले एप्लिकेशन के लिए टोकन रिफ़्रेश तंत्र लागू करें
- टोकन की समाप्ति अवधि उपयुक्त रूप से सेट करें
- सभी API अनुरोधों के लिए HTTPS का उपयोग करें