एक एपीआई की कहानी: कैसे हमने फ्रेंकस्टीन को सुंदर में बदल दिया

गैर-बैंकिंग सेवाओं के पारिस्थितिकी तंत्र और वास्तव में किसी भी समान पारिस्थितिकी तंत्र के निर्माण के लिए क्या आवश्यक है? भंडारण और प्रसंस्करण डेटा, साथ ही साथ एपीआई के लिए एक मास्टर सिस्टम। इस पोस्ट में, हम हमारे द्वारा बनाए गए एपीआई के दो संस्करणों का विश्लेषण करेंगे - पहला और सबसे सफल - और एक दूसरे के लिए उनके महत्वपूर्ण अंतर क्या हैं, इस पर ध्यान दें।



गैर-बैंकिंग सेवाओं का एक पारिस्थितिकी तंत्र बनाने के लिए, Sberbank डिजिटल कॉर्पोरेट बैंक डिवीजन के एक प्रमुख उत्पाद का चयन किया गया था - Sberbank Business Online के कॉर्पोरेट ग्राहकों के लिए एक इंटरनेट बैंक। तदनुसार, गैर-बैंकिंग सेवाओं के पारिस्थितिकी तंत्र के लिए फिनटेक एपीआई भी इसके आधार पर बनाया गया था।

फिनटेक एपीआई का पहला संस्करण 2016 में लॉन्च किया गया था। बड़े वित्तीय संगठनों के एपीआई के क्लासिक व्यंजनों के अनुसार, यह हमारे बैंक के अन्य एपीआई पर नज़र रखता है। यहाँ मुख्य घटक हैं:

• डेटा ट्रांसफर के लिए SOAP प्रोटोकॉल
  
• XML प्रारूप
  
• सभी अनुरोधों का इलेक्ट्रॉनिक हस्ताक्षर
  
• अतुल्यकालिक ऑपरेशन
  
• सुरक्षित चैनल के लिए आवश्यक हार्डवेयर-वीपीएन
  
• मालिकाना प्रमाणीकरण और प्राधिकरण प्रणाली
  
• वित्तीय जानकारी स्थानांतरित करने के लिए ऐतिहासिक रूप से स्थापित प्रारूप (उदाहरण के लिए, 1 सी प्रत्यक्ष बैंकिंग प्रारूप)
  

हमने इस तरह का निर्णय लिया और कई गैर-शास्त्रीय बैंकिंग सेवाओं के साथ पायलट एकीकरण शुरू किया: एवोटोर ऑनलाइन स्टोर, सेनेको की बिजनेस एनालिटिक्स वित्तीय प्रबंधन प्रणाली, मायऑडेलो क्लाउड-आधारित अकाउंटिंग और अन्य।

एकीकरण के परिणाम वांछित से बहुत दूर थे। आधुनिक गैर-वित्तीय सेवाओं के एपीआई से, साझेदारों को यह उम्मीद नहीं थी कि क्लासिक बैंकिंग उत्पादों के विकास में क्या प्रथा है। हम आधुनिक इंटरनेट दिग्गजों के एपीआई के समान कुछ प्राप्त करना चाहते थे: फेसबुक, गूगल, यैंडेक्स।

और अंत में, वे एक क्लासिक बैंक एपीआई में आए - भारी, अस्पष्ट, उच्च और विशिष्ट कौशल की आवश्यकता, कार्य प्रक्रियाओं की पेचीदगियों को समझना, अत्यधिक सुरक्षा आवश्यकताओं को लागू करना ... सामान्य तौर पर, बहुत सारी चीजें जो सभी संभावित समय सीमा के उल्लंघन का कारण बनती हैं।

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

• कोई भी सार्वभौमिक और भारी प्रारूप जो मामूली बारीकियों को ध्यान में नहीं रखते हैं। चलो आसान हो!
  
• एपीआई को Sberbank ग्राहकों को गैर-वित्तीय उत्पादों की पेशकश करने वाले संभावित भागीदारों की व्यापक संभव सीमा के अनुरूप होना चाहिए। जब तक स्मार्ट रेफ्रिजरेटर की शुरुआत नहीं होती है - तब तक क्या मज़ाक उड़ाया जाता है।
  
• API को विज़ुअल इंटरफेस बनाने के लिए उपयोग की जाने वाली प्रथाओं और विधियों का उपयोग करके डिज़ाइन किया जाना चाहिए। ऐसा करने के लिए, आपको एपीआई का उपयोग करने के लिए यूएक्स-योजनाओं की पहचान और विश्लेषण करने की आवश्यकता है। क्लासिक कैनन के बाद निश्चित रूप से इसके लायक नहीं है।
  
• हमें बहु-मात्रा वर्णन से छुटकारा पाने की आवश्यकता है ताकि डेवलपर्स त्वरित परिणाम प्राप्त कर सकें। परीक्षण परीक्षणों के लिए सैंडबॉक्स का उपयोग करना, आपको एक घंटे में पहला सकारात्मक परिणाम प्राप्त करने की आवश्यकता है।
  
• हम जितना संभव हो एक विशिष्ट मंच से बंधे मालिकाना समाधान से इनकार करते हैं। सब कुछ क्रॉस-प्लेटफ़ॉर्म होना चाहिए और उपयोग किए गए बुनियादी ढांचे और विकास के माहौल में भागीदार को सीमित नहीं करना चाहिए।
  
• पार्टनर्स को परेशान नहीं करना चाहिए कि वे क्या नहीं करते हैं - जटिल डेटा संरचनाएं, बैंकिंग प्लेटफ़ॉर्म घटकों के तंत्र और हमारे कानूनी सिस्टम की विशेषताएं। हम छिपते हैं और उनके सिर नहीं फोड़ते।
  

इस सूची के साथ, हम फिनटेक एपीआई के दूसरे संस्करण के कार्यान्वयन और चयनित समाधानों पर चले गए:

• OAUTH 2.0-आधारित प्रमाणीकरण
  
• अतिरिक्त जटिलता के बिना HTTP पर बाकी वास्तुकला
  
• पूरी तरह से तुल्यकालिक ऑपरेशन
  
• JSON प्रारूप
  
• इलेक्ट्रॉनिक हस्ताक्षर का वैकल्पिक उपयोग - जहां आवश्यक हो
  
• तैनात सैंडगार्ड के साथ टेस्ट सैंडबॉक्स। इस डिबगिंग परिवेश का उपयोग करते हुए, एक भागीदार का डेवलपर व्यवसाय वर्कफ़्लो का अनुकरण कर सकता है और कोड लिखे बिना परिणाम प्राप्त कर सकता है
  
• एपीआई दस्तावेज बनाने के लिए इंटरनेट स्टार्टअप द्वारा उपयोग किए जाने वाले आसान चरणों को लागू करना
  
• एपीआई डेवलपमेंट एजाइल प्रैक्टिस - फास्ट रिजल्ट्स एंड फीडबैक कलेक्शन
  

वास्तव में क्या बदल गया है

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

एपीआई के पहले संस्करण में, प्राधिकरण के लिए, भागीदार को एक उपयोगकर्ता नाम और पासवर्ड, एक प्रमाण पत्र और एक AccessToken की आवश्यकता होती है, जो लागू होने वाले ग्राहक के OAUTH प्रमाणीकरण के परिणामस्वरूप प्राप्त होता है:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:upg="http://upg.sbns.zzzzz.com/">   <soapenv:Header/>   <soapenv:Body>      <upg:preLogin>         <!--Optional:-->         <upg:userLogin>U1</upg:userLogin>         <!--Optional:-->         <upg:changePassword>!d63NvJ+Sa</upg:changePassword>      </upg:preLogin>   </soapenv:Body> </soapenv:Envelope> 

एपीआई 2.0 में, प्राधिकरण बहुत अधिक कॉम्पैक्ट हो गया है। सेवाओं तक पहुंचने के लिए, आपको केवल क्लाइंट के OAUTH प्रमाणीकरण के दौरान प्राप्त AccessToken की आवश्यकता होगी:

 { "access_token": "fdba5482-460c-4535-b829-9fd836fd01f0-1", "token_type": "Bearer", "expires_in": 3600, "refresh_token": "7f545a14-ab7b-45ff-823a-0421e9f3b42e-1", } 

एपीआई 1.0 में, रूबल भुगतान आदेश के साथ काम भी SOAP पर आधारित था:

 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:upg="http://upg.sbns.zzzzz.com/">  <soapenv:Header/>  <soapenv:Body>     <upg:sendRequestsSRP>        <!--Zero or more repetitions:-->        <upg:requests><![CDATA[       <Request xmlns='http://zzzzz.com/upg/request' orgId='84b70f22-703f-bf04-db60-bd110572f40d' requestId='a81ddc6d-fb92-416d-83f9-6785a59a4b17' version='1.0' sender='PARTNER' clientOrgIdHash='ee0fb56b01a9d9b9648a2c60549b77702eb2a6de8f2189c4349447e43b250da5' clientAccessToken='ee0fb56b01a9d9b9648a2c60549b77702eb2a6de8f2189c4349447e43b250da5-1'> <PayDocRuInvoice docExtId='a81decfd-fb92-416d-83f9-6785a59abb65' orderNum='62' deadLine='2017-04-10T17:16:03'> <PersonalAcc>40802810000000000000</PersonalAcc> <AccDoc docDate='2017-02-15' docSum='777' transKind='01' paytKind='01' priority='1'> <Purpose>!!!!! 18%</Purpose> </AccDoc> </PayDocRuInvoice> </Request>        ]]></upg:requests>        <!--Optional:-->        <upg:sessionId>5a869c00-e979-4280-b11a-6dbbb8a90214</upg:sessionId>     </upg:sendRequestsSRP>  </soapenv:Body> </soapenv:Envelope> 

एपीआई 2.0 में, एक समान तरीके से, सब कुछ बहुत सरल और अधिक समझ में आ गया है:

 {  "amount": 12.01,   "date": "2018-06-22",   "deliveryKind": "",   "expirationDate": "2018-06-23",   "externalId": "1516ec0c-761c-11e8-adc0-fa7ae01bbebc",  "operationCode": "01",  "orderNumber": "1237",   "payeeAccount": "40706810000000000000",   "paymentNumber": "1",  "priority": "5",   "purpose": "  №1237.   .",  "urgencyCode": "NORMAL",   "vat": {    "amount": 100.01,     "rate": "7",     "type": "NO_VAT" } 

हमने इलेक्ट्रॉनिक हस्ताक्षर की सुविधा भी दी। यह कैसे एपीआई 1.0 में था।


तो निवेदन देखा


यहाँ विशेषताओं की एक सूची है


और अब समाप्त हस्ताक्षर

एपीआई 2.0 में, JSON के माध्यम से सब कुछ आसान था:


खुद ही निवेदन करें


परिणामस्वरूप हस्ताक्षर

परिणाम

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

सामग्री को डिजिटल कॉर्पोरेट बैंक सेर्बैंक के प्रोजेक्ट मैनेजर एंड्री खोखलोव ने तैयार किया था