मोबाइल अनुप्रयोगों में OneNote सेवा एपीआई को एकीकृत करें

हाल ही में, Microsoft ने डेवलपर्स के लिए एक नया OneNote Services API पेश किया, जो आपको अपने एप्लिकेशन से सीधे उपयोगकर्ता की नोटबुक में नोट्स बनाने की अनुमति देता है। वर्तमान में, एपीआई पाठ, एचटीएमएल, यूआरएल और छवियों के साथ-साथ यूआरएल द्वारा वेब पेजों के स्नैपशॉट के निर्माण (बिंग का उपयोग करके) के रिकॉर्ड के निर्माण का समर्थन करता है। News360, Microsoft भागीदार के रूप में, अपने सभी मोबाइल एप्लिकेशन (iOS, Android, WinPhone और Windows 8) में एपीआई को एकीकृत करने वाले पहले लोगों में से एक था। एकीकरण आसान है - माइक्रोसॉफ्ट आईओएस, एंड्रॉइड और विंडोज के लिए एक लाइव एसडीके प्रदान करता है, साथ ही वेब और मोबाइल एप्लिकेशन के लिए एक रीस्ट एपीआई भी।



लाइव SDK आपको सबसे कम लागत पर OneNote को एकीकृत करने की अनुमति देता है, क्योंकि यह आउट-ऑफ-द-बॉक्स प्राधिकरण प्रदान करता है और पूरी रिकॉर्डिंग प्रक्रिया को सरल करता है। लेकिन News360 के पास बाहरी APIs के साथ काम करने के लिए अपना सबसिस्टम है, जो API (प्राधिकरण, साझाकरण, आदि) के साथ बातचीत करते समय मॉडल और प्रस्तुति के अलगाव पर आधारित है, इसलिए REST के माध्यम से एकीकरण किया गया था। लेकिन पहले बातें पहले।

आवेदन पंजीकरण

OneNote Services API को एकीकृत करने के लिए, पहली बात यह है कि यहां लाइव कनेक्ट के माध्यम से अपना आवेदन पंजीकृत करें ।

पंजीकरण के बाद, आप ClientID और गुप्त प्राप्त करते हैं। यदि आप एपीआई को मोबाइल एप्लिकेशन में एकीकृत कर रहे हैं, तो आपको निश्चित रूप से एपीआई सेटिंग्स अनुभाग में "मोबाइल या डेस्कटॉप क्लाइंट ऐप" सेटिंग को सक्षम करना होगा।

एक मोबाइल एप्लिकेशन में प्राधिकरण

उपयोगकर्ता को OneNote में प्रविष्टियाँ बनाने में सक्षम होने के लिए, उसे अपनी लाइव आईडी के साथ लॉग इन करना होगा।

यदि आप लाइव एसडीके का उपयोग करते हैं, तो एकीकरण बहुत सरल है। आपको ClientID और स्कोप की आवश्यकता होगी, जो आपको प्रविष्टियाँ बनाने की अनुमति देता है। Microsoft "wl.signin office.onenote_create" का उपयोग करने की सलाह देता है। लाइव एसडीके प्राधिकरण के लिए आवश्यक संपूर्ण यूआई प्रदान करता है, और प्राप्त क्रेडेंशियल्स का भंडारण भी प्रदान करता है।

REST के माध्यम से प्राधिकरण के लिए, Microsoft एक मानक OAuth2 प्राधिकरण कोड प्रवाह प्रदान करता है।

प्राधिकरण कोड प्राप्त करने के लिए, आपको WebView पर जाना होगा:

GET https://login.live.com/oauth20_authorize.srf?client_id=<your_client_id>&scope=<your_scopes>&response_type=code&redirect_uri=https://login.live.com/oauth20_desktop.srf&display=touch
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

गुंजाइश पैरामीटर "wl.signin% 20office.onenote_create" होना चाहिए। यदि आप लंबे समय तक रहने वाले टोकन और ताज़ा-टोकन तंत्र का उपयोग करने की योजना बनाते हैं, तो आपको "wl.offline_access" स्कोप का भी अनुरोध करना होगा, फिर एक्सेस टोकन के साथ आपको एक ताज़ा टोकन प्राप्त होगा, जिसका उपयोग फिर से प्राधिकरण के बिना एक्सेस टोकन को अपडेट करने के लिए किया जा सकता है। इस मामले में, परिणामी गुंजाइश "wl.signin% 20wl.offline_access% 20office.onenote_create" होगी।

मोबाइल एप्लिकेशन के लिए पैरामीटर रीडायरेक्ट_पुरी "https://login.live.com/oauth20_desktop.sivef" के बराबर होना चाहिए।

प्रदर्शन = स्पर्श पैरामीटर मोबाइल उपकरणों के लिए अनुकूलित एक प्राधिकरण वेब पेज प्रदान करता है।



सफल प्राधिकरण के बाद, WebView लिंक का अनुसरण करेगा:

 https://login.live.com/oauth20_desktop.srf?code=<your_authorization_code>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

इस संक्रमण को संसाधित किया जाना चाहिए और इसे प्राधिकरण कोड से प्राप्त किया जाना चाहिए।

उसके बाद, आप WebView को छिपा सकते हैं और किसी भी सुविधाजनक तरीके से अनुरोध निष्पादित कर सकते हैं:

 POST https://login.live.com/oauth20_token.srf “client_id=<your_clint_id>&client_secret=<your_secret>&redirect_uri=https://login.live.com/oauth20_desktop.srf&code=<your_authorization_code>&grant_type=authorization_code”
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

यदि सब कुछ सही ढंग से किया गया है, तो इस अनुरोध के जवाब में आपको एक्सेस टोकन और एक्सपायरी डेट के साथ json प्राप्त होगा, साथ ही यदि आप wl.offline_access को स्कोप में निर्दिष्ट करते हैं तो टोकन को रिफ्रेश कर सकते हैं।

 { "access_token" : "<your_access_token>", "expires_in" : <expires_in_seconds>, "refresh_token" : "<your_refresh_token>" }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

अब रिकॉर्ड बनाने के लिए एक्सेस टोकन का उपयोग किया जा सकता है।

पहुँच टोकन अद्यतन

पहुँच टोकन में 30 मिनट का जीवन काल होता है और इसे दीर्घकालिक उपयोग के लिए अद्यतन किया जाना चाहिए। एक्सेस टोकन अपडेट करने के लिए आपको अनुरोध पूरा करना होगा

 POST https://login.live.com/oauth20_token.srf “client_id=<your_clint_id>&client_secret=<your_secret>&redirect_uri=https://login.live.com/oauth20_desktop.srf&refresh_token=<your_refresh_token>&grant_type=refresh_token”
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

उत्तर को प्रारंभिक एक्सेस टोकन के समान संसाधित करने की आवश्यकता है।

OneNote में नोट्स बनाएं

सफल प्राधिकरण के बाद, आप OneNote में प्रविष्टियाँ बना सकते हैं। फिलहाल, एपीआई नोटपैड के चयन का समर्थन नहीं करता है और नोटपैड में सभी प्रविष्टियाँ बनाता है जिसे "क्विक नोट्स" कहा जाता है।

रिकॉर्ड बनाना बहुत सरल है। यदि आप टेक्स्ट और छवियों से युक्त एक साधारण प्रविष्टि बनाना चाहते हैं, जैसा कि News360 करता है, तो आपको फ़ॉर्म का एक सरल HTML-टेम्पलेट निर्दिष्ट करना होगा:

 <html> <head> <title>Story title</title> <meta name=\"created\" content=\"<ISO8601_date_string>\" />" </head> <body> <your_story_text/html> </body> </html>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

आप html को बॉडी को भी पास कर सकते हैं, जो अन्य चीजों के अलावा, img टैग का समर्थन करता है।



टेम्पलेट भरने के बाद, आपको अनुरोध पूरा करना होगा:

 POST https://www.onenote.com/api/v1.0/pages Content-Type : text/html Authorization : Bearer <your_access_token> "your_html_template_with_data"
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

यदि सब कुछ सही ढंग से किया जाता है, तो बनाया हुआ रिकॉर्ड लिंक के साथ वापस आ जाएगा:

 201 Created "{ "links" : { "oneNoteClientUrl" : {"href" : "onenote:https://..."}, "oneNoteWebUrl" : {"href" : "https://..."} } }"
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

इन लिंक का उपयोग गहरी लिंकिंग के लिए किया जा सकता है और उपयोगकर्ता अनुभव को पूरक कर सकता है - क्लाइंट url का उपयोग OneNote क्लाइंट पर जाने के लिए किया जा सकता है यदि यह डिवाइस पर इंस्टॉल किया गया है, और वेब संस्करण पर जाने के लिए वेब url का उपयोग किया जा सकता है।



इस प्रकार, OneNote Services API का एकीकरण प्राधिकरण के लिए REST API का उपयोग करते समय भी कोई कठिनाई पेश नहीं करता है। मुझे उम्मीद है कि यह लेख किसी के लिए उपयोगी है।



संबंधित लिंक:

Microsoft Office ब्लॉग - News360 और OneNote