API क्या है? AI ऐप बनाने वालों के लिए सरल गाइड
API (application programming interface) एक तय तरीका है जिससे एक सॉफ़्टवेयर दूसरे से डेटा माँगता है या उससे कोई काम करवाता है। आपका ऐप एक समझौते वाले फ़ॉर्मेट में request भेजता है — "कल की बुकिंग दो," "इस कार्ड से €20 चार्ज करो," "इस टेक्स्ट का सार बनाओ" — और दूसरा सिस्टम एक संरचित response लौटाता है। API से ही किसी ऐप के हिस्से एक-दूसरे से बात करते हैं, और इसी से आपका ऐप पेमेंट, ईमेल, मैप और AI जैसी बाहरी सेवाएँ इस्तेमाल करता है।
AI से बनाते समय API क्यों मायने रखते हैं
लगभग हर उपयोगी ऐप ऐसे हिस्सों से बना होता है जो API के ज़रिए बात करते हैं:
- आपके ऐप के अंदर, ब्राउज़र की स्क्रीन डेटा लोड और सेव करने के लिए आपके अपने बैकएंड के API को कॉल करती हैं।
- आपके ऐप के बाहर, आपका बैकएंड दूसरी कंपनियों के API को कॉल करता है: पेमेंट के लिए Stripe, रसीद भेजने के लिए ईमेल प्रोवाइडर, टेक्स्ट बनाने के लिए AI मॉडल प्रोवाइडर।
जब आप AI बिल्डर से "पेमेंट लो" या "AI सारांश जोड़ो" कहते हैं, तो वह असल में ऐसा कोड लिख रहा होता है जो एक API को कॉल करता है। इसकी बुनियादी बातें जानने से आप समझ पाते हैं कि AI को आपसे क्या चाहिए (आम तौर पर उस सेवा का खाता और एक API key), कहाँ चीज़ें गलत हो सकती हैं, और उनकी कीमत क्या होगी।
रोज़मर्रा की मिसाल
एक रेस्टोरेंट की कल्पना कीजिए। आप रसोई में जाकर खाना नहीं बनाते। आप मेन्यू पढ़ते हैं, वेटर को ऐसे बताते हैं जिसे रसोई समझ सके, और वेटर आपका खाना लाता है — या बताता है कि डिश खत्म हो गई।
- मेन्यू API का documentation है: कौन सी चीज़ें माँगी जा सकती हैं और कैसे।
- वेटर API है: अनुरोध अंदर जाने और जवाब बाहर आने का एक तय तरीका।
- रसोई दूसरा सिस्टम है: आपको अंदर का काम जानने की ज़रूरत नहीं।
- आपका ऑर्डर request है; प्लेट response है।
रसोई अपने ओवन और स्टाफ़ बदल सकती है, आपको असर नहीं पड़ता, जब तक मेन्यू वही रहे। यही API की असली कीमत है: दो सिस्टम बिना एक-दूसरे की बनावट जाने साथ काम कर सकते हैं।
वेब API request कैसे काम करती है
ज़्यादातर API जो आप देखेंगे वे HTTP पर काम करने वाले वेब API हैं, वही प्रोटोकॉल जिसे आपका ब्राउज़र इस्तेमाल करता है। हर request के कुछ हिस्से होते हैं:
| हिस्सा | यह क्या है | उदाहरण |
|---|---|---|
| Method | कार्रवाई का प्रकार | GET (पढ़ना), POST (बनाना) |
| URL / endpoint | जिस चीज़ पर कार्रवाई है उसका पता | https://api.example.com/bookings |
| Headers | अतिरिक्त जानकारी, जिसमें आप कौन हैं यह भी शामिल है | Authorization: Bearer <your key> |
| Body | जो डेटा भेजा जा रहा है, बनाने और अपडेट करने के लिए | {"name": "Lena", "time": "14:00"} |
और हर response में:
| हिस्सा | यह क्या है | उदाहरण |
|---|---|---|
| Status code | एक संख्या जो बताती है कि काम कैसा रहा | 200 OK, 201 Created, 404 Not Found |
| Body | लौटाया गया डेटा, आम तौर पर JSON में | {"id": 5001, "status": "confirmed"} |
JSON (JavaScript Object Notation) नामों और मानों का एक सरल टेक्स्ट फ़ॉर्मेट है, जो घुंघराले कोष्ठकों में लिखा जाता है। वेब API डेटा का आदान-प्रदान इसी मानक तरीके से करते हैं।
REST: सबसे आम स्टाइल
REST वेब API डिज़ाइन करने का एक व्यापक रूप से इस्तेमाल होने वाला तरीका है। हर तरह की चीज़ को अपना URL मिलता है, और मानक methods बताते हैं कि आप उसके साथ क्या कर रहे हैं। एक बुकिंग ऐप के लिए REST API कुछ ऐसा दिख सकता है:
| Method | Endpoint | क्या करता है |
|---|---|---|
GET | /api/bookings | बुकिंग की सूची देना |
GET | /api/bookings/5001 | एक बुकिंग देना |
POST | /api/bookings | नई बुकिंग बनाना |
PATCH | /api/bookings/5001 | बुकिंग का कुछ हिस्सा बदलना, जैसे उसका समय |
DELETE | /api/bookings/5001 | बुकिंग कैंसल (हटाना) |
PUT भी होता है और आम तौर पर पूरा रिकॉर्ड बदल देता है, जबकि PATCH सिर्फ़ वे फ़ील्ड बदलता है जो आप भेजते हैं।
सबसे ज़्यादा दिखने वाले status codes:
| कोड | मतलब |
|---|---|
200 / 201 | सफलता / बन गया |
400 | खराब request — आपने जो भेजा उसमें कुछ गलत या छूटा है |
401 | प्रमाणित नहीं — कोई वैध लॉगिन या key नहीं |
403 | निषिद्ध — आप पहचाने जाते हैं, पर यह करने की अनुमति नहीं है |
404 | नहीं मिला |
429 | बहुत अधिक requests — आप rate limit तक पहुँच गए |
500 | सर्वर में एरर |
जब आपका ऐप टूटता है, तो status code अक्सर सबसे तेज़ सुराग होता है। किसी पेमेंट प्रोवाइडर से 401 आना आम तौर पर API key के न होने या गलत होने का संकेत है; 429 का मतलब है कि आप बहुत बार कॉल कर रहे हैं।
REST अकेला स्टाइल नहीं है — GraphQL और RPC-शैली के API भी हैं — पर ज़्यादातर सेवाएँ और AI से बने बैकएंड REST इस्तेमाल करते हैं।
एक उदाहरण: बुकिंग की पुष्टि
जब कोई ग्राहक सैलून ऐप में हेयरकट बुक करता है, तो एक-दो सेकंड में कई API कॉल हो सकती हैं:
- ब्राउज़र में बुकिंग पेज सेवा, समय और ग्राहक का विवरण लेकर आपके बैकएंड को
POST /api/bookingsभेजता है। - आपका बैकएंड जाँचता है कि स्लॉट खाली है, बुकिंग को डेटाबेस में सेव करता है, और
201 Createdलौटाता है। - आपका बैकएंड ईमेल प्रोवाइडर के API को अपनी secret key के साथ कॉल करता है: "यह पुष्टि lena@example.com को भेजो।"
- अगर डिपॉज़िट है, तो आपका बैकएंड पेमेंट प्रोवाइडर के API से checkout session बनाने को कहता है और ग्राहक को वहाँ भेजता है।
- बाद में, पेमेंट प्रोवाइडर आपके ऐप को कॉल करके बताता है कि पेमेंट सफल हुआ। यह उल्टी दिशा वाली कॉल एक webhook है।
पहले दो चरण frontend और backend के बीच आपका अपना API है। चरण 3–5 तीसरे पक्ष के API हैं।
आम शब्दों की व्याख्या
| शब्द | मतलब |
|---|---|
| Endpoint | एक खास URL जिस पर API जवाब देता है। |
| API key | एक गुप्त स्ट्रिंग जो आपके ऐप की पहचान किसी सेवा के सामने करती है। इसे पासवर्ड की तरह संभालें। |
| Authentication | यह साबित करना कि कॉल कौन कर रहा है — key, token या लॉगिन से। देखें authentication क्या है। |
| Rate limit | एक समय-सीमा में आप कितनी requests कर सकते हैं, उसकी सीमा। |
| SDK | तैयार कोड लाइब्रेरी जो किसी खास API को कॉल करना आसान बनाती है। |
| Documentation | "मेन्यू": कौन से endpoints हैं, वे क्या लेते और लौटाते हैं। |
| Sandbox / test mode | किसी सेवा का वह वर्शन जिसमें बिना असली पैसे या असली डेटा के टेस्ट किया जा सकता है। |
| Webhook | कुछ होने पर किसी दूसरी सेवा से आपके ऐप में आने वाली कॉल। |
आम गलतियाँ और गलतफ़हमियाँ
- फ़्रंटेंड में गुप्त keys डालना। ब्राउज़र में चलने वाले कोड में जो भी है, उसे कोई भी विज़िटर देख सकता है। गुप्त keys सर्वर पर रहनी चाहिए, environment variables या secrets में।
- Keys चैट में चिपकाना। चैट का इतिहास सेव हो सकता है। इसके बजाय अपने बिल्डर का secrets फ़ीचर इस्तेमाल करें, और जो key उजागर हो गई हो उसे बदलें (rotate करें)।
- मान लेना कि API मुफ़्त है। कई API हर request या उपयोग की इकाई के हिसाब से शुल्क लेते हैं — AI मॉडल API टोकन के हिसाब से लेते हैं। कीमत जाँचें और खर्च की सीमा तय करें। देखें LLM API कैसे इस्तेमाल करें।
- विफलता को न संभालना। बाहरी सेवाएँ डाउन होती हैं, टाइमआउट होती हैं और सीमा तक पहुँचती हैं। समझदार एरर संदेश और retries माँगें।
- ब्राउज़र पर भरोसा करना। आपके अपने API को अनुमति खुद जाँचनी चाहिए। बटन छिपा देने से कोई सीधे endpoint को कॉल करने से नहीं रुकता।
- टेस्ट में लाइव keys इस्तेमाल करना। लॉन्च के लिए तैयार होने तक test mode keys इस्तेमाल करें।
अपने AI बिल्डर से क्या माँगें
- "यह ऐप कौन से बाहरी API इस्तेमाल करता है, और उनमें से हरेक की कीमत क्या है?"
- "पेमेंट API को सिर्फ़ सर्वर से कॉल करो। key एक environment variable से पढ़ो।"
- "हमारे API का हर endpoint सूचीबद्ध करो, वह क्या करता है और उसे कौन कॉल कर सकता है।"
- "बुकिंग को बदलने या हटाने से पहले सर्वर पर जाँचो कि लॉगिन किया हुआ यूज़र उसका मालिक है।"
- "अगर ईमेल API फ़ेल हो जाए, तो फिर भी बुकिंग सेव करो और एरर लॉग करो।"
- "अभी के लिए प्रोवाइडर का test mode इस्तेमाल करो।"
Mythex में API
Mythex आपका अपना API बना सकता है — एक वेब ऐप के हिस्से के रूप में, या एक अलग बैकएंड के रूप में जो Node, Python (FastAPI), C# या Java में आपके फ़्रंटेंड के साथ चलता है — और बाहरी सेवाओं को कॉल करने वाला कोड लिख सकता है। आप उनकी keys चैट में नहीं, प्रोजेक्ट secrets के रूप में जोड़ते हैं, और वे प्रिव्यू में और प्रकाशित होने के बाद आपके ऐप को उपलब्ध रहती हैं। डॉक्स में किसी भी API को इंटीग्रेट करने और REST API बैकएंड बनाने की रेसिपी हैं।
सवाल
सरल शब्दों में API क्या है?
API (application programming interface) एक तय तरीका है जिससे एक सॉफ़्टवेयर दूसरे से डेटा माँगता है या कोई काम करवाता है। आपका ऐप एक तय फ़ॉर्मेट में request भेजता है, और दूसरा सिस्टम response लौटाता है — जैसे मौसम का डेटा, पेमेंट का नतीजा या AI का बनाया जवाब।
REST API क्या है?
REST API वेब API का एक आम स्टाइल है, जिसमें हर तरह की चीज़ (बुकिंग, ग्राहक) का अपना URL होता है, और आप मानक HTTP methods इस्तेमाल करते हैं — पढ़ने के लिए GET, बनाने के लिए POST, अपडेट के लिए PUT या PATCH, और हटाने के लिए DELETE। डेटा आम तौर पर JSON में वापस आता है।
API key क्या है और उसे कहाँ रखें?
API key एक गुप्त स्ट्रिंग है जो आपके ऐप को किसी सेवा के सामने पहचान देती है, और अक्सर पैसा खर्च करने या डेटा तक पहुँचने देती है। उसे environment variables या सर्वर पर आपके प्रोजेक्ट के secrets में रखें — ब्राउज़र में चलने वाले कोड में कभी नहीं, और किसी सार्वजनिक repository में भी नहीं।
API और webhook में क्या फ़र्क है?
API में आपका ऐप जब चाहे किसी सेवा से कुछ माँगता है। Webhook में दूसरी सेवा कुछ होने पर आपके ऐप को कॉल करती है — उदाहरण के लिए, पेमेंट प्रोवाइडर आपको बताता है कि पेमेंट सफल हुआ।