परियोजना का विवरण
अनुवादितहमारी कंपनी ने एक REST API बनाया है जिसका उपयोग साझेदार डेवलपर्स हमारे प्लेटफॉर्म के साथ एकीकृत करने के लिए करते हैं, लेकिन वर्तमान दस्तावेज़ पुराना और आंतरिक विकियों और पुराने स्प्रेडशीट्स में बिखरा हुआ है। हम एक अनुभवी तकनीकी लेखक की तलाश कर रहे हैं जो हमारे मौजूदा एंडपॉइंट्स को एक साफ, संरचित संदर्भ में बदल सके जिस पर डेवलपर्स भरोसा कर सकें बिना हर बार हमारे समर्थन टीम को ईमेल किए जब वे फंस जाते हैं।
यह नौकरी हर सार्वजनिक एंडपॉइंट को कवर करती है: प्रत्येक विधि के कार्य का स्पष्ट विवरण, आवश्यक और वैकल्पिक पैरामीटर का पूरा विवरण प्रकार और डिफ़ॉल्ट मानों के साथ, प्रमाणीकरण और त्रुटि प्रबंधन, और JSON में वास्तविक अनुरोध और प्रतिक्रिया उदाहरण। लिखित संदर्भ के अलावा, हम एक इंटरैक्टिव परीक्षण पृष्ठ चाहते हैं जहां साझेदार डेवलपर्स अपने स्वयं के कुंजी डाल सकें, नमूना अनुरोध भेज सकें, और सीधे ब्राउज़र में लाइव प्रतिक्रियाएँ देख सकें।
हम एक स्टेजिंग वातावरण, मौजूदा आंतरिक नोट्स, और हमारे बैकएंड डेवलपर्स के साथ सीधे संवाद प्रदान कर सकते हैं ताकि जटिल एंडपॉइंट्स को स्पष्ट किया जा सके। आदर्श उम्मीदवार के पास REST APIs, JSON, प्रमाणीकरण योजनाओं जैसे टोकन या API कुंजी, और इंटरैक्टिव दस्तावेज़ बनाने के उपकरणों के साथ व्यावहारिक अनुभव होना चाहिए। कृपया पहले लिखी गई दस्तावेज़ों के उदाहरण साझा करें, साथ ही एक अनुमानित समयरेखा।
डिलिवरेबल्स:
— सभी एंडपॉइंट्स और पैरामीटर के लिए संरचित संदर्भ
— प्रत्येक विधि के लिए अनुरोध और प्रतिक्रिया उदाहरण
— साझेदार डेवलपर्स के लिए इंटरैक्टिव परीक्षण पृष्ठ
— नए एकीकृत करने वालों के लिए संक्षिप्त ऑनबोर्डिंग गाइड
यह नौकरी हर सार्वजनिक एंडपॉइंट को कवर करती है: प्रत्येक विधि के कार्य का स्पष्ट विवरण, आवश्यक और वैकल्पिक पैरामीटर का पूरा विवरण प्रकार और डिफ़ॉल्ट मानों के साथ, प्रमाणीकरण और त्रुटि प्रबंधन, और JSON में वास्तविक अनुरोध और प्रतिक्रिया उदाहरण। लिखित संदर्भ के अलावा, हम एक इंटरैक्टिव परीक्षण पृष्ठ चाहते हैं जहां साझेदार डेवलपर्स अपने स्वयं के कुंजी डाल सकें, नमूना अनुरोध भेज सकें, और सीधे ब्राउज़र में लाइव प्रतिक्रियाएँ देख सकें।
हम एक स्टेजिंग वातावरण, मौजूदा आंतरिक नोट्स, और हमारे बैकएंड डेवलपर्स के साथ सीधे संवाद प्रदान कर सकते हैं ताकि जटिल एंडपॉइंट्स को स्पष्ट किया जा सके। आदर्श उम्मीदवार के पास REST APIs, JSON, प्रमाणीकरण योजनाओं जैसे टोकन या API कुंजी, और इंटरैक्टिव दस्तावेज़ बनाने के उपकरणों के साथ व्यावहारिक अनुभव होना चाहिए। कृपया पहले लिखी गई दस्तावेज़ों के उदाहरण साझा करें, साथ ही एक अनुमानित समयरेखा।
डिलिवरेबल्स:
— सभी एंडपॉइंट्स और पैरामीटर के लिए संरचित संदर्भ
— प्रत्येक विधि के लिए अनुरोध और प्रतिक्रिया उदाहरण
— साझेदार डेवलपर्स के लिए इंटरैक्टिव परीक्षण पृष्ठ
— नए एकीकृत करने वालों के लिए संक्षिप्त ऑनबोर्डिंग गाइड
पाठ और अनुवाद नकद, बैंक ट्रांसफर
