API के साथ अपने टूल जोड़ें

API किसी बाहरी एप्लिकेशन को आपकी Organization के डेटा तक प्रोग्राम के ज़रिए पहुँच देती है: सदस्य संख्या, Calendar, Booking और Billing। यह दो क्लिक में चालू हो जाती है और एक key, अनुमत पतों की सूची तथा खपत की निगरानी से सुरक्षित रहती है।

जानें कि API आपके लिए उपयोगी है या नहीं

API एक डेवलपर के लिए है, किसी Organization के Manager के लिए नहीं। यह आपके खाते को उस सॉफ़्टवेयर से संवाद कराने का काम करती है जिसे आप लिखवाते या कॉन्फ़िगर कराते हैं: एक कस्टम वेबसाइट, लेखांकन का कोई टूल, अपना बनाया डिस्प्ले स्क्रीन, किसी दूसरी प्रणाली की ओर एक पुल।

रोज़मर्रा की ज़रूरतों के लिए — Member की सूची निकालना, बड़ी संख्या में Subscription अपडेट करना, कार्यालय को आँकड़े भेजना — इम्पोर्ट, एक्सपोर्ट और रिपोर्ट के मॉड्यूल बिना कोड की एक भी पंक्ति लिखे यह काम कर देते हैं।

API बीटा संस्करण में उपलब्ध है: इसका कामकाज अभी बदल सकता है।

API चालू करें और अपनी key प्राप्त करें

1. प्रशासन›सेटिंग्स›API BETA में जाएँ।
2. एपीआई मॉड्यूल सक्रिय करें चालू करें, फिर सहेजें पर क्लिक करें।
3. आपकी API कुंजी प्रदर्शित होती है: इसे कॉपी करें बटन से कॉपी करें और केवल उसी टूल को दें जिसे आप जोड़ रहे हैं।

key हर अनुरोध के X-API-Key HTTP हेडर में भेजी जाती है। कॉल अनिवार्य रूप से HTTPS में किए जाते हैं; कोई भी बिना एन्क्रिप्शन वाला अनुरोध स्वीकार नहीं किया जाता।

key की सुरक्षा करें

कुछ बातें उस टूल या सेवा प्रदाता को याद दिलाने योग्य हैं जो इसका उपयोग करता है:

• key को कभी किसी कोड रिपॉज़िटरी में न रखें; इसे रिपॉज़िटरी के बाहर किसी कॉन्फ़िगरेशन फ़ाइल या किसी सीक्रेट मैनेजर में रखें;
• जैसे ही टूल किसी स्थिर सर्वर से कॉल करता है, अनुमत पतों को सीमित कर दें;
• ज़रा भी संदेह हो तो key फिर से जनरेट करें — गलती से प्रकाशित हो जाना, लॉग का लीक होना, किसी सेवा प्रदाता का कार्यकाल समाप्त होना।

पुनः उत्पन्न करें बटन पुष्टि माँगता है, फिर पुरानी key को तत्काल अमान्य कर देता है। जो भी एप्लिकेशन उसका उपयोग कर रहे थे, वे नई key मिलने तक काम करना बंद कर देते हैं: क्लिक करने से पहले उन्हें सूचित करें।

IP पते के अनुसार पहुँच सीमित करें

आईपी पते द्वारा प्रतिबंध चालू करें: केवल उन पतों से आने वाले अनुरोध स्वीकार किए जाते हैं जिन्हें आप सूचीबद्ध करते हैं, अधिकतम 10 IPv4 पतों की सीमा में। प्रत्येक पता दर्ज करें, फिर जोड़ें से पुष्टि करें; आपकी मदद के लिए आपका वर्तमान पता स्क्रीन पर दिखाया जाता है।

यह सबसे कारगर सुरक्षा है, और सबसे अधिक अनदेखी की जाने वाली भी: उजागर हो जाने पर भी, आपके सेवा प्रदाता के पते तक सीमित key कहीं और उपयोग में नहीं आ सकती।

खपत पर नज़र रखें

स्क्रीन लगातार दिखाती है कि आपकी key कितनी खपत कर रही है:

• इस मिनट का उपयोग और आज का उपयोग, और जब कोई सीमा कॉन्फ़िगर की गई हो तो प्रत्येक को उसकी सीमा के सापेक्ष दिखाया जाता है;
• उपयोग के आंकड़े : इस सप्ताह, इस महीने, कुल और अंतिम अनुरोध।

बताई गई सीमाओं से आगे, अतिरिक्त अनुरोध अस्थायी रूप से अस्वीकार कर दिए जाते हैं। जो काउंटर हमेशा अपनी ऊपरी सीमा के करीब रहता है, वह आम तौर पर किसी गलत तरह से सेट किए गए टूल का संकेत देता है, जो डेटा को कैश में रखने के बजाय उसी डेटा को बार-बार माँगता रहता है।

अंतिम अनुरोध की तारीख उलटी दिशा में उपयोगी है: चालू की गई लेकिन महीनों से कभी कॉल न हुई key वह key है जिसे बंद कर देना चाहिए।

जानें कि API से क्या-क्या संभव है

पैरामीटरों और कॉल के उदाहरणों सहित पूरी डॉक्यूमेंटेशन मॉड्यूल की स्क्रीन के नीचे प्रदर्शित होती है। मोटे तौर पर:

• User: यही एकमात्र संसाधन है जिसे बदला जा सकता है। आप खातों को सूचीबद्ध कर सकते हैं, देख सकते हैं, बना सकते हैं, बदल सकते हैं और हटा सकते हैं।
• Configuration: Subscription, प्रोफ़ाइल, समूह और आयु श्रेणियाँ देखी जा सकती हैं, लेकिन इनकी Configuration केवल एप्लिकेशन से ही होती है।
• Booking: Calendar, उपलब्ध Time Slots, Booking और Labels देखे जा सकते हैं।
• Billing: Billing account, Order और भुगतान देखे जा सकते हैं।