प्रमाणीकरण¶
हेल्थ फिटनेस एपीआई पर सभी अनुरोधों के लिए एपीआई कुंजी के माध्यम से प्रमाणीकरण की आवश्यकता होती है। आपकी एपीआई कुंजी सिस्टम को निम्नलिखित कार्य करने की अनुमति देती है:
- अपने एप्लिकेशन की पहचान और प्राधिकरण करना
- उपयोग और कोटा को ट्रैक करना
- संवेदनशील स्वास्थ्य और फिटनेस डेटा तक सुरक्षित पहुंच सुनिश्चित करना
⚠️ अपनी एपीआई कुंजी को गोपनीय रखें। इसे सार्वजनिक रूप से उजागर न करें या क्लाइंट-साइड कोड में एम्बेड न करें।
उपयोगकर्ता प्रकार (केवल हेफिटएपीआई प्लेटफॉर्म)¶
प्रत्येक क्लाइंट (प्रशासक) हेफिटएपीआई प्लेटफॉर्म पर दो प्रकार के उपयोगकर्ताओं को बना सकता है:
- डेवलपर उपयोगकर्ता
- एपीआई एंडपॉइंट तक पहुंचने के लिए क्लाइंट (प्रशासक) द्वारा बनाया गया।
- एपीआई सुविधाओं का उपयोग करने की अनुमति है; सभी एपीआई हिट को प्रशासक क्लाइंट के लिए बिल किया जाता है।
-
डेवलपर उपयोगकर्ता, प्रशासक की तरह, अपनी एपीआई कुंजी का उपयोग करके एपीआई कॉल करते हैं।
-
वित्त उपयोगकर्ता
- वित्तीय कार्यों का प्रबंधन करने के लिए क्लाइंट (प्रशासक) द्वारा बनाया गया।
- बिल देखने, एपीआई क्रेडिट को टॉप अप करने और क्लाइंट/संगठन के लिए उपयोग को मॉनिटर करने की क्षमता है।
- एंडपॉइंट पर एपीआई कॉल नहीं कर सकते; वित्त एपीआई कुंजी केवल बिलिंग एक्सेस तक सीमित है।
⚠️ ये भूमिकाएँ और प्रतिबंध केवल हेफिटएपीआई प्लेटफॉर्म के लिए विशिष्ट हैं।
अपनी एपीआई कुंजी प्राप्त करना¶
- हेल्थ फिटनेस एपीआई डैशबोर्ड पर साइन अप या लॉग इन करें।
- अपने खाते की सेटिंग्स के अंतर्गत "एपीआई कुंजियाँ" पर नेविगेट करें।
- अपने एप्लिकेशन या उपयोगकर्ता के लिए एक नई एपीआई कुंजी उत्पन्न करें।
- कुंजी को कॉपी करें और इसे सुरक्षित रूप से संग्रहीत करें।
अपनी एपीआई कुंजी का उपयोग कैसे करें¶
हेडर प्रमाणीकरण (अनुशंसित)¶
अपनी एपीआई कुंजी को अनुरोध हेडर में शामिल करें:
curl -X GET "https://api.hefitapi.com/api/v1/bmi?weight=81&height=177" \
-H "X-API-Key: YOUR_API_KEY"
क्वेरी पैरामीटर प्रमाणीकरण (वैकल्पिक)¶
आप एपीआई कुंजी को क्वेरी पैरामीटर के रूप में भी भेज सकते हैं:
⚠️ क्वेरी पैरामीटर प्रमाणीकरण हेडर की तुलना में कम सुरक्षित है। इसका उपयोग केवल परीक्षण या सर्वर-साइड स्क्रिप्ट के लिए करें।
रैपिडएपीआई विधि¶
आप रैपिडएपीआई के माध्यम से क्लासिक हेल्थ कैलकुलेटर एपीआई तक भी पहुंच सकते हैं:
curl -X GET "https://rapidapi.com/dakidarts-dakidarts-default/api/health-calculator-api" \
-H "X-RapidAPI-Key: YOUR_RAPIDAPI_KEY" \
-H "X-RapidAPI-Host: health-calculator-api.p.rapidapi.com"
⚠️ ध्यान दें: नए v1.0.0 हेल्थ फिटनेस एपीआई सुविधाएँ (35+ नए एंडपॉइंट, 8 भाषाओं का समर्थन) रैपिडएपीआई के माध्यम से उपलब्ध नहीं हैं। सभी वर्तमान एंडपॉइंट और पूर्ण भाषा समर्थन के लिए https://api.hefitapi.com पर मुख्य एपीआई का उपयोग करें।
सर्वोत्तम प्रथाएँ¶
- कभी भी क्लाइंट-साइड ऐप्स या सार्वजनिक रिपॉजिटरी में एपीआई कुंजियों को हार्डकोड न करें।
- सुरक्षा के लिए एपीआई कुंजियों को नियमित रूप से बदलें।
- विकास, परीक्षण और उत्पादन वातावरण के लिए अलग-अलग कुंजियों का उपयोग करें।
- कोटा सीमाओं तक पहुँचने से बचने के लिए डैशबोर्ड के माध्यम से अपने एपीआई उपयोग की निगरानी करें।
- एपीआई कुंजी को ट्रांजिट में सुरक्षित रखने के लिए HTTPS का उपयोग करना सुनिश्चित करें।
उदाहरण अनुरोध¶
curl -X GET "https://api.hefitapi.com/api/v1/tdee?weight=81&height=177&age=36&gender=male&activity_level=moderately_active" \
-H "X-API-Key: YOUR_API_KEY"
उदाहरण प्रतिक्रिया¶
{
"tdee": 2762.15,
"bmr": 1782.03,
"activity_multiplier": 1.55,
"profile": {
"age": 36,
"weight_kg": 81.0,
"height_cm": 177.0,
"gender": "male",
"activity_level": "moderately_active"
},
"language": "en",
"_api_metadata_": {
"endpoint_name": "tdee",
"authenticated": true
}
}
नोट्स¶
- प्रत्येक एंडपॉइंट के लिए एक मान्य एपीआई कुंजी की आवश्यकता होती है।
- अमान्य या गुम कुंजियाँ एक
401 Unauthorizedप्रतिक्रिया लौटा देंगी। - एपीआई कुंजियाँ आपके खाते की योजना से जुड़ी होती हैं; उपलब्ध अनुरोधों के लिए अपनी कोटा की जांच करें।
- v1.0.0 एंडपॉइंट रैपिडएपीआई के माध्यम से समर्थित नहीं हैं और https://api.hefitapi.com तक सीधे पहुंच की आवश्यकता होती है।
- डेवलपर उपयोगकर्ताओं के पास एपीआई कॉल करने की अनुमति है; वित्त उपयोगकर्ताओं को एपीआई एंडपॉइंट तक पहुंचने की अनुमति नहीं है और वे केवल बिलिंग तक ही सीमित हैं।