API कुंजियाँ — tnea_ और tnsr_¶

NumerologyAPI दो प्रकार के API कुंजी परिवारों का उपयोग करता है। दोनों दिखने में समान होती हैं, समान 80-अक्षर वाले सुरक्षित प्रारूप में उत्पन्न होती हैं, और समान X-API-Key हेडर से प्रमाणित होती हैं — लेकिन उनकी मीटरिंग अलग होती है और वे अलग-अलग उत्पादों के लिए होती हैं।

1. कुंजी प्रारूप और सुरक्षा¶

हर कुंजी बिल्कुल 80 अक्षर लंबी होती है:

tnea_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
tnsr_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

• 4-अक्षर वाला उपसर्ग कुंजी के प्रकार की पहचान करता है; शेष 75 अक्षर क्रिप्टोग्राफ़िक रूप से सुरक्षित यादृच्छिक स्रोत से उत्पन्न होते हैं।
• कुंजियाँ सर्वर-साइड पर SHA-256 हैश करके संग्रहीत की जाती हैं। प्लेनटेक्स्ट कुंजी केवल एक बार, निर्माण के समय दिखाई जाती है।
• यदि कुंजी कभी उजागर हो जाए, तो डैशबोर्ड से उसे तुरंत रोटेट करें।

2. प्लेटफ़ॉर्म कुंजियाँ (tnea_)¶

प्लेटफ़ॉर्म कुंजियाँ NumerologyAPI को अपने उत्पाद — वेबसाइट, मोबाइल ऐप और सर्वर-साइड सेवाओं में एकीकृत करने के लिए मानक कुंजियाँ हैं।

प्रमाणीकरण¶

हर अनुरोध पर X-API-Key हेडर के साथ कुंजी भेजें:

curl --request GET \
  --url "https://api.numerologyapi.com/api/v1/life_path?birth_year=1990&birth_month=5&birth_day=15" \
  --header "x-api-key: tnea_YOUR_API_KEY"

मीटरिंग¶

बिलेबल /api/v1 कॉल आपके संगठन के क्रेडिट वॉलेट (पे-एज़-यू-गो) से काटी जाती हैं। आप डैशबोर्ड से किसी भी समय वॉलेट में राशि जोड़ सकते हैं।

चैनल नियम: प्लेटफ़ॉर्म कुंजियों को X-Numora-Client हेडर नहीं भेजना चाहिए। इसे भेजने पर 403 मिलता है — वह हेडर केवल डेस्कटॉप चैनल के लिए आरक्षित है।

3. Numora Studio कुंजियाँ (tnsr_)¶

Numora Studio कुंजियाँ Numora Studio डेस्कटॉप ऐप (macOS/Windows) को प्रमाणित करती हैं, जिसका उपयोग प्रैक्टिशनर क्लाइंट रिपोर्ट बनाने के लिए करते हैं। वे समान प्रारूप वाली प्लेटफ़ॉर्म कुंजियों की सहयोगी हैं, लेकिन उनका बिल प्लेटफ़ॉर्म क्रेडिट के बजाय संगठन की Numora Studio प्लान स्वीकृति के विरुद्ध लगाया जाता है।

प्रावधान¶

एक tnsr_ कुंजी निम्न में से किसी एक तरीके से बनाई जाती है:

• डेस्कटॉप ऐप साइन-इन प्रवाह के माध्यम से (ब्राउज़र सहमति पृष्ठ स्वचालित रूप से कुंजी प्रदान करता है), या
• डैशबोर्ड के API कुंजियाँ पृष्ठ (/api-keys) पर मैन्युअल रूप से।

चैनल हस्ताक्षर (अनिवार्य)¶

tnsr_ कुंजी से की गई हर कॉल में डेस्कटॉप चैनल हेडर शामिल होना चाहिए:

सर्वर प्रवर्तन:

• tnsr_ कुंजी बिना X-Numora-Client के → 403।
• tnea_ कुंजी सहित X-Numora-Client → 403।

मीटरिंग¶

• बिलेबल /api/v1 कॉल संगठन की Numora Studio प्लान स्वीकृति से काटी जाती हैं (संगठन की सभी tnsr_ कुंजियों के लिए एक साझा पूल)।
• प्रत्येक tnsr_ कुंजी पर एक क्रेडिट फ़ॉलबैक टॉगल मौजूद है: जब प्लान स्वीकृति समाप्त हो जाती है, तो कुंजी संगठन के प्लेटफ़ॉर्म क्रेडिट पर फ़ॉलबैक कर सकती है (डिफ़ॉल्ट रूप से बंद)।
• यदि स्वीकृति समाप्त हो गई है और कोई फ़ॉलबैक सक्षम नहीं है, तो कॉल 429 लौटाती हैं।

डिवाइस लॉकिंग (वैकल्पिक)¶

एक tnsr_ कुंजी को पंजीकृत डिवाइसों तक लॉक किया जा सकता है। लॉकिंग सक्षम होने पर, हर अनुरोध में संगठन के पास पंजीकृत एक X-Numora-Device-Id होना चाहिए; अपंजीकृत डिवाइसों को 403 के साथ अस्वीकार कर दिया जाता है।

केवल-डेस्कटॉप एंडपॉइंट¶

कुछ एंडपॉइंट केवल डेस्कटॉप चैनल के लिए आरक्षित हैं और tnea_ कुंजियों के लिए 403 लौटाते हैं:

• POST /api/v1/numora/report-bundle — एक कॉल में पूर्ण क्लाइंट रिपोर्ट
• POST /api/v1/numora/order — ऐप के भीतर प्लान/स्वीकृति खरीद प्रवाह
• POST /api/v1/numora/devices/register — डेस्कटॉप इंस्टॉलेशन पंजीकृत करें
• GET /api/v1/numora/studio-status — डेस्कटॉप शेष राशि और कोटा मीटर

सुझाव: बिलेबल प्रतिक्रियाओं में X-Remaining-Credits और X-Remaining-Tokens हेडर भी शामिल होते हैं, ताकि आप बिना अतिरिक्त कॉल के लाइव शेष राशि ट्रैक कर सकें।

4. कुंजियाँ प्रबंधित करना (डैशबोर्ड)¶

डैशबोर्ड का API कुंजियाँ पृष्ठ (/api-keys) दोनों प्रकार की कुंजियों के लिए नियंत्रण केंद्र है।

भूमिकाएँ: admin और developer भूमिकाएँ कुंजियाँ बना और प्रबंधित कर सकती हैं। finance उत्पादन API कुंजियाँ नहीं बना सकती। वित्तीय कार्रवाइयाँ (प्लान खरीद, टॉप-अप) केवल admin और finance तक सीमित हैं।

एकाधिक कुंजियाँ: संगठन दोनों प्रकार की कई कुंजियाँ रख सकते हैं — उदाहरण के लिए प्रति प्रैक्टिशनर या प्रति डेस्कटॉप इंस्टॉलेशन एक tnsr_ कुंजी। स्वीकृतियाँ संगठन के स्तर पर साझा होती हैं, इसलिए कुंजियाँ कभी भी अपने शेष के लिए "प्रतिस्पर्धा" नहीं करतीं।

5. सर्वोत्तम अभ्यास¶

• कुंजियों को पासवर्ड की तरह मानें। उन्हें कभी भी क्लाइंट-साइड कोड, सार्वजनिक रिपॉजिटरी या लॉग में एम्बेड न करें।
• अपने बैकएंड में पर्यावरण चर या सीक्रेट्स मैनेजर का उपयोग करें।
• यदि कुंजी समझौता हो जाए या कोई टीम सदस्य जाता है, तो तुरंत रोटेट करें।
• डिवाइस प्रबंधन और रद्दीकरण को सरल बनाने के लिए प्रति डेस्कटॉप इंस्टॉलेशन एक tnsr_ कुंजी का उपयोग करें।
• उच्च-सुरक्षा वाले संगठनों के लिए डिवाइस लॉकिंग सक्षम करें।
• अप्रत्याशित स्पाइक्स को जल्दी पकड़ने के लिए डैशबोर्ड में उपयोग की निगरानी करें।

6. सामान्य प्रश्न¶

क्या tnsr_ कुंजी नियमित प्लेटफ़ॉर्म एंडपॉइंट कॉल कर सकती है? हाँ। Numora Studio कुंजियाँ पूरे /api/v1 सतह को प्रमाणित करती हैं; उन कॉलों का बिल Numora Studio प्लान स्वीकृति के विरुद्ध लगाया जाता है।

क्या tnea_ कुंजी केवल-डेस्कटॉप /numora/* एंडपॉइंट कॉल कर सकती है? नहीं। केवल-डेस्कटॉप एंडपॉइंट प्लेटफ़ॉर्म कुंजियों के लिए 403 लौटाते हैं।

मुझे अपनी tnsr_ कुंजी से कॉल करने पर 403 क्यों मिलता है? सबसे संभावित कारण X-Numora-Client हेडर का गायब होना या ऐप आईडी का मेल न खाना है। जाँचें कि हर अनुरोध में X-Numora-Client: numora-studio/<version> शामिल है।

मुझे अपनी tnea_ कुंजी से 403 क्यों मिलता है? प्लेटफ़ॉर्म कुंजियों पर X-Numora-Client हेडर नहीं होना चाहिए — इसे हटा दें।

जब मेरी स्वीकृति समाप्त हो जाती है तो क्या होता है? बिलेबल कॉल 429 लौटाती हैं, जब तक कि आपकी tnsr_ कुंजी पर क्रेडिट फ़ॉलबैक सक्षम न हो (या आप tnea_ कुंजियों के लिए अपना प्लेटफ़ॉर्म वॉलेट टॉप-अप करते हैं)।

संबंधित¶

• शुरुआत
• मूल्य निर्धारण
• एंटरप्राइज़ समाधान