iPhone या iPad पर शॉर्टकट में अपने पहले API के लिए अनुरोध करें
अपने पहले API का अनुरोध करने के लिए, आप URL बनाते हैं जो उस API “endpoint” को इंगित करता जिससे आप बात करना चाहते हैं और फिर उस URL को प्राप्त करें Contents of URL क्रिया में पास करता है। जब शॉर्टकट रन होता है, तो यह क्रिया API अनुरोध करता है।
API अनुरोध बनाएँ
Typicode के अंतिमबिंदू के लिए URL अनुरोध को इस तरीक़े से फ़ॉर्मैट किया जाना आवश्यक है :
https://jsonplaceholder.typicode.com/[RESOURCE]
ब्रैकेट में मौजूद टेक्स्ट वह रिसोर्स है जिसे आप ऐक्सेस करना चाहेंगे। परीक्षण के अनुरोधों के लिए Typicode कई अलग-अलग उदाहरण प्रदान करता है। यूज़र की सूची के लिए अनुरोध करने हेतु यह उदाहरण https://jsonplaceholder.typicode.com/users
का उपयोग करेगा।
अपने iOS या iPadOS डिवाइस पर शॉर्टकट ऐप में URL के लिए अनुरोध जोड़ें।
यूज़र
के लिए अनुरोध करने से यूज़र की सूची प्राप्त होगी।आप id के अनुसार विशिष्ट यूज़र को निर्दिष्ट करके अपनी खोज को सीमित कर सकते हैं :
https://jsonplaceholder.typicode.com/users/6
। इससे वह यूज़र प्राप्त होगा जिसका id 6 है।अधिकतर API निम्नलिखित फ़ॉर्मैट का उपयोग करके क्वेरी की अनुमति देते हैं :
https://jsonplaceholder.typicode.com/users?username=Bret
। “?” प्रश्न पूछना शुरू करता है, जो की/मान युग्म का उपयोग करते हुए आइटम की खोज करता है। इस उदाहरण में, क्वेरी?username=Bret
द्वारा ऐसे यूज़र को खोजा जाता जिसका नाम ब्रेट है।समर्थित खोजों और क्वेरी के लिए अपने API का दस्तावेज़ीकरण देखें।
प्राप्त करें Contents of URL के साथ API अनुरोध करें
अपने iOS या iPadOS डिवाइस पर शॉर्टकट ऐप में “URL के कॉन्टेंट प्राप्त करें” क्रिया में “अधिक दिखाएँ” पर टैप करें।
API अनुरोधों के लिए आप निम्नलिखित विकल्पों को उपलब्ध बना सकते हैं :
GET
आपको नया डेटा प्राप्त करने की अनुमति देता है।POST
आपको नया डेटा तैयार करने की अनुमति देता है।PUT
की मदद से आप डेटा बदलकर उसे अपडेट कर सकते हैं।PATCH
की मदद से आप डेटा संशोधित करके अपडेट कर सकते हैं।DELETE
आपको URL अनुरोध में निर्दिष्ट ऑब्जेक्ट को हटाने की अनुमति देता है।
इस उदाहरण के लिए, Typicode API से डेटा रिट्रीव करने के लिए
GET
अनुरोध का उपयोग करें।अब URL क्रिया के पास आपका अनुरोध है और प्राप्त करें Contents of URL क्रिया को
GET
डेटा पर सेट किया गया है, आप API अनुरोध बनाने के लिए तैयार हैं।नोट : प्राप्त करें Contents of URL क्रिया के
POST
,PUT
, याPATCH
पर स्विच होने पर, Request Body नामक पैरामीटर जोड़ा जाता है। Request Body आपको JSON, एक फ़ॉर्म, एक फ़ाइल को एक अनुरोध के रूप में API को भेजने की अनुमति देता है। यह आपको नया डेटा मैनुअली दर्ज करने या वैरिएबल की मदद से दर्ज करने की सुविधा देता है ताकि आप एंट्री बनाने, बदलने या रूपांतरित करने के लिए API को डेटा भेजा जा सके।शॉर्टकट का परीक्षण करने के लिए पर टैप करें।
पहली नज़र में, ऐसा लगता है कि API ढेर सारा टेक्स्ट रिटर्न करता है। यह डेटा JSON में एनकोडेड होता है, जिसका अर्थ है JavaScript Object Notation।
JSON के साथ काम करने के बारे में जानने और Typicode API उदाहरण के साथ जारी रखने के लिए iPhone और iPad पर शॉर्टकट में JSON का उपयोग करने का परिचय देखें।