एपीआई जो आपको रोता है

क्या उम्मीद करें?

लक्ष्य डेवलपर्स को यह दिखाने के लिए है कि विभिन्न सीआरएम सिस्टम के साथ काम करने के उदाहरण पर उनके एपीआई उपयोगकर्ताओं को क्या समस्याएं आ रही हैं।

अपने चेहरे की सुरक्षा के लिए, मैं इस लेख में प्रतिभागियों के नाम का विज्ञापन नहीं करूँगा।
इसके अलावा, मैं - मैं अपनी मां की प्रेमिका का प्रोग्रामर नहीं हूं, इसलिए केवल सही विकल्प के लिए मेरे निष्कर्ष को न लें।

आईलाइनर

एक बार एक उम्मीद वाला लड़का रहता था। लेखांकन कार्यक्रमों के तकनीकी समर्थन में काम के अलावा इस लड़के के जीवन में कुछ भी नहीं था। वह लंबे समय तक इस गोभी में पकाते रहे, एक दिन में, उन्होंने अपनी छत को फाड़ दिया, और उन्होंने मुख्य मेजबान विशेषता को भेजा और संभावनाओं की तलाश में छोड़ दिया।

लड़का हमेशा इस बारे में सपना देखता था कि वह कैसे कूल डेवलपर बनेगा, वह असाधारण पैसा कमाएगा, अधिमानतः बसुराम मुद्रा में। और इसलिए, काम के समानांतर, वह अपनी साइट के निर्माण में लगे हुए थे, प्रौद्योगिकियों का अभूतपूर्व उपयोग करते हुए, लेकिन उन वर्षों के लिए अनसुनी सुविधाओं के साथ। इसके लिए धन्यवाद, वह एक नए मालिक को खोजने में सक्षम था, जिसने उसे अपने पसंदीदा व्यवसाय में अच्छी तनख्वाह के साथ, और अवास्तविक संभावनाओं के साथ नौकरी दी।

तब से, लड़का रहता था, रहता था, और अच्छा बनाता था। और वह मुसीबतों और दुखों को नहीं जानता था ... या वह जानता था? चलो यह पता लगाने!

मुझे एक बिजनेस इंटेलिजेंस कंपनी में नौकरी मिली। और डेटा के बिना किस तरह का एनालिटिक्स हो सकता है? इसलिए, कंपनी की एक अलग टीम थी, और फिर एक विभाग जो विज्ञापन साइटों और अन्य स्रोतों से राजस्व कार्यक्रम बनाने के लिए ग्राहक साइटों से डेटा एकत्र करने में लगा हुआ था। बारीकियों के बारे में बोलते हुए, मेरा काम साइटों पर हमारे काउंटर को स्थापित करना था, आगंतुक के बारे में डेटा एकत्र करना, और फॉर्म, ऑनलाइन चैट, कॉलबैक आदि से एप्लिकेशन बनाना था। उनके सीआरएम सिस्टम में। जिनमें से, भविष्य में, हमारे विश्लेषिकी ने बिक्री की स्थिति और राशि के बारे में जानकारी खींच ली।

और यहां कुछ भी जटिल नहीं लगता है, यह देखते हुए कि हमारे सिस्टम को लपेटकर सीआरएम में अनुप्रयोगों के निर्माण को सरल बनाया गया था, जिसने 1 अनुरोध का उपयोग करके, एप्लिकेशन और क्लाइंट बनाया, जिसमें तृतीय-पक्ष सेवाओं का प्रभार भी शामिल है। लेकिन जैसा कि आपको समझना चाहिए, इस तरह के तर्क लचीलेपन में भिन्न नहीं होते हैं। और अगर ग्राहक को कुछ गैर-मानक की आवश्यकता होती है, तो पहले से ही "आराम मोड को बंद करना" आवश्यक था और वांछित प्रणाली के एपीआई के साथ सीधे काम करने के लिए अपनी आस्तीन ऊपर रोल करें। और कभी-कभी, अगली समस्याग्रस्त एपीआई के साथ काम करते हुए, मुझे लगता है कि उन में रहना बेहतर होगा। समर्थन ...

समस्या # 1: तरीकों / डेटा की कमी

शायद सबसे आम समस्या जो मुझे अपने जीवनकाल में झेलनी पड़ी है, वह है इंटरफ़ेस में मेरे द्वारा आवश्यक डेटा प्राप्त करने की क्षमता का अभाव। ग्राहकों के साथ संघर्ष लगातार उठता रहा और उठता रहा, इस तथ्य के कारण कि हमें कुछ ऐसा नहीं मिल सकता है जो वे हर दिन अपने मॉनिटर की स्क्रीन पर देखते हैं।

उदाहरण के लिए, कुछ साल पहले, बल्कि एक बड़ा क्लाइंट हमारे पास आया था जो सीआरएम फाइलों में सहेजने की जरूरत थी जो क्लाइंट साइट पर मौजूद फॉर्म से उसे भेजते हैं। एक साधारण कार्य, लेकिन कार्यान्वयन की कोई संभावना नहीं थी, और आज तक नहीं!

क्लाइंट के लिए विफलता अस्वीकार्य थी, और अंत में हमें इंटरफ़ेस से जेएस अनुरोधों का अनुकरण करते हुए, फाइलें अपलोड करनी थीं।

मुझे कहना होगा कि यह सीआरएम, एपीआई में प्राधिकरण, इंटरफ़ेस में भी अधिकृत करता है, जो कि मेरे लिए, बल्कि एक अजीब समाधान है। हालांकि, इसके लिए धन्यवाद, हमें सामान्य प्राधिकरण का अनुकरण करने की आवश्यकता नहीं थी। या, क्या इसकी कल्पना की गई थी ...?

उसी CRM के साथ एक और मामला बहुत पहले नहीं हुआ था। आवेदन प्रबंधक के लिए जिम्मेदार होना आवश्यक था जो वर्तमान में सक्रिय है। और जैसा कि आप पहले से ही समझ चुके हैं, एपीआई हमें प्रबंधक गतिविधि के बारे में जानकारी नहीं देता है। लेकिन विरोधाभास यह है कि उनका जेएस एपीआई रिटर्न करता है। नतीजतन, मुझे एक जेएस आवेदन, एक प्रकार का मध्यस्थ लिखना पड़ा, जिसके साथ मैंने सर्वर को फिलहाल सक्रिय प्रबंधकों के बारे में सूचित किया।

समाधान:
हमारी टीम में, यह इंटरफ़ेस के लिए एक सार्वजनिक एपीआई विधि बनाने के लिए प्रथागत है, और पहले से ही इसके माध्यम से सर्वर के साथ बातचीत करता है। यह इंटरफ़ेस की तकनीकी क्षमताओं और सार्वजनिक एपीआई के बीच बेमेल की समस्या को समाप्त करता है।

समस्या संख्या 2: अनुरोधों / प्रतिक्रियाओं की एक समान शैली की कमी

बड़े पश्चिमी CRMs में भी एक बहुत ही आम समस्या है। मान लें कि हमें एक महीने के लिए आदेशों की एक सूची प्राप्त करने की आवश्यकता है, तो हमें पता चलता है कि सिस्टम में अपलोड में तत्वों की संख्या की सीमा है। और उन पृष्ठों को नेविगेट करने के लिए जिन्हें आपको ऑफ़सेट पैरामीटर का उपयोग करने की आवश्यकता है। ठीक है, हमने लोडिंग ऑर्डर की विधि, और अलग से, पेजिंग की सहायक विधि को लागू किया है।
अब, हमें ग्राहकों की सूची को अनलोड करने की आवश्यकता है, हम पहले से लिखे गए पेजिनेशन विधि के साथ एक नई विधि लागू कर रहे हैं, और ... हमें एक त्रुटि मिलती है। क्योंकि पीएम और डेवलपर्स ने तय किया कि ऑफसेट बहुत आसान है, अब इसे vid-ऑफ़सेट होने दें।

निश्चित रूप से मैं अतिशयोक्ति करता हूं, मैं नहीं जान सकता कि जब उन्होंने यह एपी लिखा था तो क्या हुआ था। लेकिन यह कम से कम एक पीएम त्रुटि है, क्योंकि उन्होंने यह निर्दिष्ट नहीं किया कि यह पहले से ही अन्य तरीकों से कैसे लागू किया गया था। और डेवलपर्स की भी गलती है, जिन्होंने एक नई विधि लिखी है, और जिन्हें जांचा गया था। अभी के लिए, हर कोई जो अपने एपीआई का उपयोग करता है, अपने अनुप्रयोगों में बैसाखी बनाने के लिए मजबूर होता है।

समाधान:
यदि संभव हो तो कोई नया एपी-विधि, मौजूदा लोगों की संरचना के अनुरूप होना चाहिए। तकनीकी नेतृत्व (या पहले की कमी के लिए टीम का नेतृत्व) एक विनियमन, एक प्रकार की कोड शैली बना सकता है, जिसके अनुसार एपी को विकसित करना आवश्यक है, और इसके साथ सभी डेवलपर्स को परिचित करने में विफल। यदि समस्या के पास पहले से ही एक जगह है, तो, यदि संभव हो तो, अपने पक्ष में हजारों ग्राहकों को अपने पक्ष में करने के लिए मजबूर करने के बजाय अपनी तरफ से बैसाखी लगाना बेहतर है।

समस्या संख्या 3: खराब प्रलेखन या उसके अभाव

प्रलेखन एक डेवलपर संदर्भ है। जब हम किसी विशेष सुविधा को लागू करने की संभावना के बारे में पूछा जाता है तो हम अक्सर परिस्थितियों का सामना करते हैं। और अगर हमें याद नहीं है या उत्तर नहीं पता है, तो तुरंत प्रलेखन खोलें। एक अच्छी निर्देशिका में जानकारी खोजने के लिए कुछ मिनटों के लिए काम करना है, जबकि एक अतिभारित में आप आधे घंटे के लिए खुदाई कर सकते हैं, और फिर भी आपको एक निश्चित उत्तर नहीं मिलेगा।

कुछ उन्नत मामलों में, सार्वजनिक डोमेन में इसे खोजना असंभव है। और अगर आपको तरीकों की अप-टू-डेट सूची प्राप्त करने की आवश्यकता है, तो आपको तकनीकी सहायता से संपर्क करना होगा। और फिर आपको यह देखने की आवश्यकता है कि क्या कुछ नया दिखाई दिया है, कि हमने कुछ ग्राहकों से पूछा ...

समाधान:
मैं कुछ बिंदु दूंगा, जो मेरे लिए, गुणवत्ता प्रलेखन की विशेषता है:

• नाम, विवरण और विधि मापदंडों द्वारा खोज
• विधि के उद्देश्य का सही वर्णन
• प्रकार और विवरण के साथ स्वीकृत मापदंडों की सूची
• प्रकार और विवरण के साथ लौटे मापदंडों की सूची
• उदाहरण का अनुरोध करें
• प्रतिक्रिया उदाहरण
• विवरण के साथ संभावित त्रुटि कोड
• एक सैंडबॉक्स जिसमें आप डिजाइन मोड में अनुरोधों के साथ "चारों ओर खेल सकते हैं"
• त्वरित संदर्भ के लिए सभी एपीआई विधियों का इतिहास बदलें

समस्या संख्या 4: प्राधिकरण बाइक

आप इस अद्भुत भावना को जानते हैं जब आप एक नई प्रणाली के प्रलेखन को खोलते हैं, और वहां, प्राधिकरण अनुभाग में, केवल 1 अनुरोध के लिए एक महत्वपूर्ण वैधता प्राप्त करने के लिए 3 विधियों के एक आदेश का वर्णन किया गया है ...? तो, मेरे पास नहीं है।

यह मेरे लिए एक रहस्य है कि डेवलपर्स अपनी बाइक के पक्ष में Oauth 2.0 को क्यों छोड़ देते हैं? और ठीक है, यदि प्राधिकरण एक निरंतर टोकन तक सीमित है, लेकिन यहां संपूर्ण प्राधिकरण श्रृंखला है ...

समाधान:
जब पहले से तैयार मानक हों तो आपको अपनी साइकिल को फिर से नहीं बनाना चाहिए। दरअसल, इन मानकों के लिए, डेवलपर्स के पास पहले से ही सरल प्राधिकरण के लिए अपने स्वयं के घटक हैं।

उपसंहार

मैंने आज तक की अपनी यात्रा की शुरुआत में 4 समस्याओं के बारे में बात की थी। मैंने उनके समाधान प्रदान करने की कोशिश की, लेकिन वे तय करने के लिए अच्छे हैं या नहीं। अंत में, हम में से प्रत्येक के पास विचार की अपनी वास्तुकला है।

इसलिए, मैं उन सभी को धन्यवाद देता हूं जिन्होंने अब तक पढ़ा है! यह मेरा पहला लेख है, और यदि इसमें आपके लिए सूचनात्मक मूल्य है, तो मुझे एपीआई के साथ मेरी पीड़ा के बारे में लेखों की श्रृंखला जारी रखने में खुशी होगी।

और निश्चित रूप से, मुझे टिप्पणियों में विशेषज्ञों की राय सुनने में खुशी होगी।

आने वाले 2020 के साथ सभी!