टाइप किया गया अनुबंध
प्रलेखित समापन बिंदु और उदाहरण समर्थित अनुरोधों और प्रतिक्रियाओं को स्पष्ट करते हैं।
डेवलपर एपीआई
समान मान्य अनुबंधों के माध्यम से लिंक संचालन को स्वचालित करें।
Gods.ly API एक प्रकाशित OpenAPI विनिर्देशन का अनुसरण करता है। स्वचालित उपकरण डैशबोर्ड के समान ही कार्यक्षेत्र जांच, इनपुट सत्यापन, पुनः प्रयास सुरक्षा और स्थिति नियम प्राप्त करते हैं।
खुला एकीकरणसीमित पहुंच
एपीआई-कुंजी मेटाडेटा स्पष्ट अनुमतियों को रिकॉर्ड करता है और संग्रहीत प्लेनटेक्स्ट रहस्यों को कभी नहीं लौटाता है।
पूर्वानुमेय त्रुटियाँ
मानक त्रुटि प्रतिक्रियाएं अमान्य फ़ील्ड की व्याख्या करती हैं और समर्थन के लिए एक अनुरोध आईडी शामिल करती हैं।
डुप्लिकेट बनाए बिना पुनः प्रयास करें
अनुरोध बनाने में एक अद्वितीय पुनः प्रयास कुंजी शामिल हो सकती है। यदि किसी कनेक्शन का समय समाप्त हो जाता है, तो उसी संपत्ति को दो बार प्रकाशित किए बिना उसी अनुरोध को दोबारा भेजा जा सकता है।
संस्करण जांच एक अपडेट को किसी अन्य व्यक्ति या प्रक्रिया से नए परिवर्तन को चुपचाप अधिलेखित करने से रोकती है।
प्रत्येक कार्यक्षेत्र को अलग रखें
क्रेडेंशियल एक पहचान और कार्यक्षेत्र से जुड़े होते हैं। सर्वर प्रत्येक अनुरोध के लिए सदस्यता, अनुमति, स्वामित्व और वर्तमान स्थिति की पुष्टि करता है।
किसी अन्य कार्यक्षेत्र से किसी पहचानकर्ता का अनुमान लगाना उस संसाधन को देखने या बदलने के लिए कभी भी पर्याप्त नहीं है।
बिना किसी रुकावट के विकास करें
जेनरेट किए गए क्लाइंट और स्कीमा संगतता जांच से निर्माण के दौरान अनुबंध परिवर्तन दृश्यमान हो जाते हैं। एडिटिव फ़ील्ड सुरक्षित रहते हैं जबकि परिवर्तनों को तोड़ने के लिए संस्करणबद्ध माइग्रेशन पथ की आवश्यकता होती है।
डेवलपर कार्यक्षेत्र में स्कोप्ड एपीआई कुंजी बनाएं और प्रबंधित करें। अप्रयुक्त कुंजियों को रद्द करें और सक्रिय रहस्यों को विश्वसनीय वातावरण में रखें।
सामान्य प्रश्न
शुरू करने से पहले टीमें क्या पूछती हैं।
क्या कोई जेनरेटेड क्लाइंट है?
हाँ। एपीआई दस्तावेज़ में समर्थित क्लाइंट उदाहरण और वर्तमान ओपनएपीआई अनुबंध शामिल हैं।
मैं एपीआई क्रेडेंशियल कहां प्रबंधित कर सकता हूं?
स्कोप्ड कुंजी बनाने, उनकी अनुमतियों की समीक्षा करने और एकीकरण समाप्त होने पर पहुंच रद्द करने के लिए डेवलपर कार्यक्षेत्र का उपयोग करें।
वास्तविक वर्कफ़्लो से शुरुआत करें