API-आधारित फ़ॉर्म और प्रोग्राम से डेटा का आदान-प्रदान

API से कस्टम फ़ॉर्म बनाना सीखें। फ़ॉर्म सबमिशन को अपने एप्लिकेशन और डेटा सिस्टम से जोड़ें और जानें कि API कब काम आती है।

ड्राफ़्ट

ज़्यादातर लोग ब्राउज़र में फ़ॉर्म भरते हैं। लेकिन डेवलपर कस्टम एप्लिकेशन, मोबाइल ऐप, एम्बेडेड सिस्टम और इंटरनल टूल में भी फ़ॉर्म बनाते हैं। ये फ़ॉर्म ड्रैग-एंड-ड्रॉप फ़ॉर्म बिल्डर इस्तेमाल नहीं करते। वे अपना डेटा सीधे आपके फ़ॉर्म प्लेटफ़ॉर्म को भेजने के लिए API इस्तेमाल करते हैं।

इस लेख में बताया गया है कि फ़ॉर्म API कैसे काम करती है, आपको उसकी ज़रूरत कब पड़ती है, और ऐसा फ़ॉर्म प्लेटफ़ॉर्म चुनते समय क्या देखें जो मज़बूत API एक्सेस देता हो।

फ़ॉर्म API क्या है और डेवलपर इसे क्यों इस्तेमाल करते हैं

फ़ॉर्म API डेवलपर के लिए ब्राउज़र फ़ॉर्म की जगह प्रोग्राम से फ़ॉर्म डेटा सबमिट करने का तरीका है। वेब फ़ॉर्म पर कोई "submit" बटन दबाए, इसकी जगह डेवलपर ऐसा कोड लिखता है जो डेटा सीधे फ़ॉर्म सिस्टम को भेज देता है।

आप ऐसा कब करेंगे?

कस्टम एप्लिकेशन बनाते समय: आप अपना ऐप बना रहे हैं और फ़ॉर्म डेटा इकट्ठा करने के लिए अपने फ़ॉर्म टूल को बैकएंड की तरह इस्तेमाल करना चाहते हैं। आपका कोड सबमिट करने के लिए फ़ॉर्म API को कॉल करता है।

मोबाइल ऐप से फ़ॉर्म सबमिशन: आपके मोबाइल ऐप में फ़ॉर्म है। जब यूज़र सबमिट करते हैं, तो ऐप का कोड फ़ॉर्म API को कॉल करता है।

कई स्रोतों का डेटा जोड़ते समय: आप अलग-अलग सिस्टम से डेटा इकट्ठा कर रहे हैं और चाहते हैं कि सब कुछ एक ही फ़ॉर्म प्लेटफ़ॉर्म पर जाए। आपका इंटीग्रेशन कोड फ़ॉर्म API इस्तेमाल करता है।

बैच ऑपरेशन: आपके पास हज़ारों रिकॉर्ड हैं जिन्हें इम्पोर्ट करना है। उन्हें हाथ से डालने की जगह आपका कोड फ़ॉर्म API से उन्हें प्रोग्राम से सबमिट करता है।

फ़ॉर्म API कैसे काम करती है (कोड समझे बिना)

फ़ॉर्म API ऐसे काम करती है: आपके एप्लिकेशन के पास डेटा है। वह उस डेटा को फ़ॉर्म प्लेटफ़ॉर्म पर भेजना चाहता है। वह एक API कॉल करता है (इसे एक संदेश की तरह समझें) जो कहती है "यह कुछ डेटा है, कृपया इसे स्टोर करें।" फ़ॉर्म प्लेटफ़ॉर्म उसे लेता है, वैलिडेट करता है और स्टोर कर देता है, ठीक वैसे ही जैसे किसी ने वेब फ़ॉर्म भरकर सबमिट दबाया हो।

फ़ॉर्म प्लेटफ़ॉर्म एक रिस्पॉन्स लौटाता है जो पुष्टि करता है कि सबमिशन मिल गया और स्टोर हो गया।

फ़ॉर्म प्लेटफ़ॉर्म की नज़र में API सबमिशन का डेटा वेब फ़ॉर्म सबमिशन के डेटा जैसा ही होता है। दोनों को बराबर माना जाता है।

API ऑथेंटिकेशन और सुरक्षा

जब आपका कोड फ़ॉर्म API को कॉल करता है, तो उसे साबित करना होता है कि वह अधिकृत है। यह ऑथेंटिकेशन से होता है, आम तौर पर API की से।

API की आपके एप्लिकेशन के लिए पासवर्ड जैसी है। आप उसे गुप्त रखते हैं। जब आपका कोड डेटा सबमिट करना चाहता है, तो वह API की साथ भेजता है। फ़ॉर्म प्लेटफ़ॉर्म की जाँचता है और कहता है "हाँ, यह एप्लिकेशन अधिकृत है।"

अपनी API की को कभी पब्लिक कोड में न डालें और न किसी से साझा करें। अगर किसी को आपकी की मिल जाए, तो वह आपकी ओर से फ़ॉर्म डेटा सबमिट कर सकता है (जो समस्या बन सकती है अगर आप फ़ॉर्म सबमिशन से बिज़नेस के ज़रूरी फ़ैसले लेते हैं)।

रेट लिमिटिंग: कितनी API कॉल की इजाज़त है

ज़्यादातर फ़ॉर्म प्लेटफ़ॉर्म सीमित करते हैं कि आप कितनी API कॉल कर सकते हैं। इससे दुरुपयोग रुकता है और सिस्टम सुरक्षित रहता है।

एक आम सीमा "हर API की पर हर घंटे 1,000 API कॉल" हो सकती है। अगर आपका एप्लिकेशन सीमा से ज़्यादा कॉल करता है, तो घंटा रीसेट होने तक आगे की कॉल रिजेक्ट हो जाती हैं।

फ़ॉर्म प्लेटफ़ॉर्म चुनते समय API की रेट लिमिट देखें। अगर आपको हर घंटे 10,000 सबमिशन करने हैं, तो हर घंटे 1,000 कॉल की सीमा आपके काम नहीं आएगी। प्लेटफ़ॉर्म से ऊँची सीमा या स्केलिंग के विकल्पों के बारे में पूछें।

API रिस्पॉन्स और एरर हैंडलिंग

जब आपका कोड फ़ॉर्म API को कॉल करता है, तो उसे एक रिस्पॉन्स मिलता है। यह रिस्पॉन्स बताता है कि सबमिशन सफल रहा या फ़ेल।

सफलता का रिस्पॉन्स: HTTP 200 या 201। सबमिशन मिल गया और स्टोर हो गया। आपका कोड आगे बढ़ सकता है।

एरर रिस्पॉन्स: HTTP 400, 401, 500 आदि। कुछ गलत हुआ। आपके कोड को एरर संभालना चाहिए (दोबारा कोशिश करना, लॉग करना, किसी को अलर्ट करना)।

अच्छे API एरर संदेश बताते हैं कि क्या गलत हुआ। "Missing required field: email" मददगार है। बिना ब्योरे वाला "Error" नहीं।

API से बैच सबमिशन

कभी-कभी आपको एक साथ कई सबमिशन करने होते हैं। कुछ API बैच ऑपरेशन सपोर्ट करती हैं: आप 100 अलग कॉल करने की जगह एक ही API कॉल में 100 सबमिशन भेज देते हैं।

बैच सबमिशन ज़्यादा कारगर होते हैं। इनसे API कॉल की संख्या घटती है और काम जल्दी पूरा होता है।

जाँचें कि आपके फ़ॉर्म प्लेटफ़ॉर्म की API बैच सबमिशन सपोर्ट करती है या नहीं। अगर आपको बड़ी मात्रा में डेटा इम्पोर्ट करना है, तो यह फ़ीचर मायने रखता है।

API के नज़रिये से वेबहुक नोटिफ़िकेशन

जब डेटा API से आता है, तो आप नोटिफ़िकेशन या फ़ॉलो-अप एक्शन चाह सकते हैं। कुछ फ़ॉर्म प्लेटफ़ॉर्म API सबमिशन के लिए भी वेबहुक नोटिफ़िकेशन भेजते हैं, ठीक वैसे ही जैसे वेब फ़ॉर्म सबमिशन के लिए।

इसका मतलब है कि अगर आपका कोड API से सबमिट करता है, तब भी आपके आगे के सिस्टम (CRM, ईमेल आदि) को अपने आप सूचना मिल जाती है।

API डॉक्यूमेंटेशन और डेवलपर अनुभव

अच्छी फ़ॉर्म API का डॉक्यूमेंटेशन बेहतरीन होता है। वह बताता है कि ऑथेंटिकेट कैसे करें, कौन सा endpoint कॉल करें, कौन सा डेटा फ़ॉर्मेट इस्तेमाल करें, कौन से एरर मिल सकते हैं, और उसमें कोड के उदाहरण होते हैं।

खराब API डॉक्यूमेंटेशन डेवलपर की ज़िंदगी मुश्किल बना देता है। अगर आप फ़ॉर्म प्लेटफ़ॉर्म चुन रहे हैं और आपको API एक्सेस चाहिए, तो पहले उनका API डॉक्यूमेंटेशन पढ़ें। क्या वह साफ़ है? क्या उदाहरण हैं? क्या आप उसे समझ पा रहे हैं?

API कब इस्तेमाल करें और वेब फ़ॉर्म कब

वेब फ़ॉर्म तब इस्तेमाल करें जब: आप चाहते हैं कि विज़िटर ब्राउज़र में फ़ॉर्म भरें। आपको कोड नहीं चाहिए। फ़ॉर्म बिल्डर का ड्रैग-एंड-ड्रॉप इंटरफ़ेस काफ़ी है।

API तब इस्तेमाल करें जब: आप डेवलपर हैं और कस्टम एप्लिकेशन बना रहे हैं। आपको प्रोग्राम से डेटा सबमिट करना है। आप कई डेटा स्रोत जोड़ रहे हैं। आपको पूरा सबमिशन अनुभव अपने हिसाब से बनाना है।

अक्सर आप दोनों इस्तेमाल करते हैं। वेबसाइट पर विज़िटर के लिए वेब फ़ॉर्म होते हैं। आपका इंटरनल एप्लिकेशन प्रोग्राम से सबमिशन के लिए API इस्तेमाल करता है।

फ़ॉर्म API और WEMASY

WEMASY में आप वेबसाइट बिल्डर से अपनी वेबसाइट पर फ़ॉर्म जोड़ सकते हैं। अगर आपको API से फ़ॉर्म डेटा भेजना है, तो ऊपर बताई बातें, जैसे ऑथेंटिकेशन, रेट लिमिट और एरर हैंडलिंग, किसी भी प्लेटफ़ॉर्म को चुनने से पहले जाँचें। WEMASY के प्लान और कीमतें प्राइसिंग पेज पर देखें।

अक्सर पूछे जाने वाले सवाल

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

और पढ़ें: फ़ॉर्म के बारे में सब कुछ

इसे अभी आज़माएँ
अपनी खुद की वेबसाइट पर।

WEMASY के साथ मुफ़्त शुरू करें और कुछ ही मिनटों में अपनी साइट बनाएँ।