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