आपकी साइट अकेले सब कुछ नहीं करती। पेमेंट, ईमेल, SMS, मैप या कैलेंडर जैसी बाहरी सेवाओं से बात करने के लिए API इस्तेमाल होती है। इसे ऐसे समझें कि आपकी साइट किसी दूसरी सेवा से कुछ माँगती है और जवाब पाती है।
शुरुआत में तीन शब्द ज़रूरी हैं: कुंजी (key), वेबहुक और सुरक्षा। इन्हें समझ लें तो ज़्यादातर इंटीग्रेशन सीधे हैं।
API कीज़ को चैट या कोड में न डालकर प्रोजेक्ट सीक्रेट में रखें, Uttra को सेवा और अपेक्षित नतीजा बताएं, और वेबहुक को सिग्नेचर से सत्यापित करवाएं।
API और की क्या होती हैं
API एक तय तरीका है जिससे दो सिस्टम बात करते हैं। की (API key) एक गुप्त स्ट्रिंग है जो साबित करती है कि अनुरोध आपके अकाउंट से आ रहा है। उसे पासवर्ड की तरह संभालें।
- पब्लिक की: जिसे ब्राउज़र में दिखाना सुरक्षित हो, जैसे कुछ मैप या एनालिटिक्स की।
- सीक्रेट की: जो सिर्फ़ सर्वर पर रहनी चाहिए, जैसे पेमेंट या SMS की।
वेबहुक क्या है
आम API में आपकी साइट पूछती है। वेबहुक में बाहरी सेवा खुद आपकी साइट को बताती है, जैसे "पेमेंट सफल हुआ"। इसके लिए आपकी साइट पर एक पता चाहिए जो ये संदेश ले सके, और उसे जाँचना चाहिए कि संदेश सचमुच उसी सेवा से आया है, आमतौर पर सिग्नेचर से।
Uttra को कैसे बताएं
शुरुआत में कोडिंग की ज़रूरत नहीं। सेवा का नाम और जो नतीजा चाहिए वह बताएं, Uttra कनेक्शन लिख देता है। फिर भी उस सेवा में आपका अकाउंट और उसकी की चाहिए। सैंपल प्रॉम्प्ट:
- "जब कोई ग्राहक ऑर्डर करे तो ईमेल भेजने वाली सेवा से कन्फ़र्मेशन ईमेल भेजो। उसकी की का नाम EMAIL_API_KEY रखो और उसे प्रोजेक्ट सीक्रेट से पढ़ो। अगर भेजना फ़ेल हो तो ऑर्डर फिर भी सेव करो और त्रुटि लॉग करो।"
सुरक्षा के नियम
इन आदतों से ज़्यादातर बड़ी गलतियाँ रुक जाती हैं।
- की को चैट में पेस्ट न करें, उसे सीक्रेट के रूप में जोड़ें। चैट में डाली चीज़ लॉग या कोड में पहुँच सकती है।
- सीक्रेट को GitHub जैसी रिपॉज़िटरी में कमिट न करें।
- जिस की से सिर्फ़ ज़रूरी अनुमति मिलती हो, वही बनाएं।
- की लीक हो जाए तो उसे तुरंत बदलें।
- टेस्ट मोड की कीज़ से शुरू करें और असली पैसे का इस्तेमाल बाद में।
टेस्ट करें और निगरानी रखें
प्रीव्यू में पूरा फ़्लो एक बार चलाएं: ऑर्डर दें, देखें कि ईमेल या पेमेंट का नतीजा सही आया। सेवा बंद होने जैसी स्थिति पर भी सोचें, ताकि आपकी साइट पूरी तरह रुक न जाए।