पेट स्टोर API का परिचय
यह दस्तावेज़ एक सैंपल पेट स्टोर सर्वर के लिए एपीआई संदर्भ प्रदान करता है। यहाँ दिए गए अनुरोध डेवलपर्स को पेट स्टोर सर्वर पर कॉल करने में मदद कर सकते हैं, ताकि वे सिस्टम में दर्ज किसी भी पालतू जानवर और ऑर्डर के बारे में डेटा भेज सकें या अनुरोध कर सकें।
पेट स्टोर एपीआई के साथ, एक डेवलपर निम्नलिखित कर सकता है:
पालतू जानवर
- डेटाबेस में पालतू जानवर बनाएं, पढ़ें, अपडेट करें और हटाएं।
- किसी पालतू जानवर के लिए एक छवि अपलोड करें।
- पालतू जानवरों को उनकी स्थिति (उपलब्ध, लंबित, बिकी हुई), टैग, या अद्वितीय पहचानकर्ताओं द्वारा खोजें।
स्टोर
- स्थिति के अनुसार वर्गीकृत, पालतू जानवरों की सूची प्राप्त करें।
- किसी पालतू जानवर के लिए ऑर्डर दें।
- खरीद ऑर्डर को उनकी आईडी द्वारा खोजें।
- एक ऑर्डर रद्द करें।
उपयोगकर्ता
- एक नया उपयोगकर्ता खाता बनाएँ (व्यक्तिगत रूप से या एक सूची से)।
- उपयोगकर्ताओं को सिस्टम में लॉग इन और आउट करें।
- किसी उपयोगकर्ता को उनकी आईडी से खोजें।
- किसी उपयोगकर्ता की जानकारी को उनके उपयोगकर्ता नाम से प्राप्त करें, अपडेट करें और हटाएँ।
यह उदाहरण एक कुत्ते (क्रिप्टो) और आईडी नंबर 210 का उपयोग करता है।
कनेक्शन पूर्वापेक्षाएँ
सभी API अनुरोधों का बेस URL https://petstore3.swagger.io/api/v3 है।
प्रमाणीकरण
Petstore की API से अपने कनेक्शन को प्रमाणित करने के लिए, OAuth 2.0 या एक निर्दिष्ट API कुंजी का उपयोग करें। कुंजी का अनुरोध करने के लिए, budbaker@bhavenpets.com पर ईमेल करें।
सुरक्षा कारणों से, API कुंजियों को अन्य उपयोगकर्ताओं के साथ साझा न करें। यदि आपको अपनी API कुंजी की सुरक्षा में किसी तरह की चूक का संदेह है, तो कृपया पुरानी कुंजी को रद्द करने और एक नई कुंजी जारी करने के लिए तुरंत किसी प्रशासक से संपर्क करें।