OneNote Team Reveals API Roadmap

7

Last week, OneNote launched the initial version of their API. The first set of features are focused on scenarios for creating pages in OneNote: mobile app scanners, hardware scanners, save-it-for-later for newsreaders, etc. The team has already started working on the next set of features.  Here is a list of the capabilities and features that OneNote is planning to deliver over the next 3 to 6 months. 

  1. PDF Rendering. In the current API, you can create a page with a PDF attachment, but it cannot be rendered onto the page directly. This feature will enable a PDF to be rendered onto the page, making it usable directly on the OneNote page. Since PDF is by far the most popular scan format, this is particularly important to scanner scenarios.
  2. Improved error codes. Today, our error codes and messages aren’t very helpful. For example, if you missed including the office.onenote_create scope when you asked your user to sign in, when you call the page create API, you will just get a 401 Unauthorized error back with no message telling you that you are missing the office.onenote_create scope. We would like to provide richer error messages, particularly for the 4XX type client errors, so we can help you pinpoint what is wrong with your request.
  3. API to create in a specific notebook and section. In the current API, all the pages created through the API will end up in the default location (see our blog post on the default page location). This feature will enable developers to create UI to let the user pick a specific location where the page should be created.
  4. API to create a notebook. Lets your app create a new notebook. (i.e. POST https://www.onenote.com/api/v1.0/notebooks)
  5. API to create a section. Lets your app create a new section within a notebook. (i.e. POST https://www.onenote.com/api/v1.0/sections)
  6. API to do whole page replacement. This will be the first version of our page update API, which is to enable you to replace the entire page (i.e. PUT https://www.onenote.com/api/v1.0/pages/{id}).
  7. API to get default location. For apps that don’t want to go through the hassle of creating UI to let the user pick where he wants the page to be created, they can use this API to at least get back the default notebook name and section name to show the user which location the page is going to be created in.
  8. Checkbox and other tag support. This would allow developers to use TODO’s and other types of tags in OneNote. Note that tags in OneNote aren’t page-level tags like in a blog post. OneNote tags are things like TODO, Important, Question, etc.

    onenote 7506.image_7171107A

  9. API to delete a notebookdelete a section and delete a page.
    (i.e. DELETE https://www.onenote.com/api/v1.0/notebooks/{id},
    DELETE https://www.onenote.com/api/v1.0/sections/{id},
    DELETE https://www.onenote.com/api/v1.0/pages/{id})
  10. API to recall list of pages. Enables an app to enumerate all the pages in the user’s notebooks. For example, your app might want to list the most recently created pages in OneNote to let the user choose a page to add its content into your app. (i.e. GET https://www.onenote.com/api/v1.0/pages)
  11. API to recall page content. We expect most developers will use this API along with #10 to get the contents of a page back and use it inside the app. (i.e. GET https://www.onenote.com/api/v1.0/pages/{id})
  12. API to recall images across notebooks or within a notebook. This is useful in scenarios where you want to enumerate all of the images stored inside the user’s notebooks and allow them to pick the ones they want to use in your app. (i.e. GET https://www.onenote.com/api/v1.0/images orGET https://www.onenote.com/api/v1.0/notebooks/{id}/images)

OneNote API feedback site has been created to vote on features and submit ideas.

Source: OneNote Dev Blog



About Author

Suril is a scientist, journalist and obsessive Microsoft observer. He holds an advanced degree in Biotechnology with minors in Biochemistry, Microbiology, and Molecular Biology. Send him tips on twitter: http://www.twitter.com/surilamin

  • Gromanon

    OneNote is literally the best things since notebook was invented. Use it on my every computing device I own.

    • hushv

      Same here. i use it as my journal (tis a pity i can’t password that section.) I use it for all my class subjects except one.

      • Adam Lein

        You can password protect sections using the full Windows Desktop version of OneNote, but you won’t be able to access them on any of the mobile clients (only the desktop client).

        • hushv

          Thanks. I hate using the desktop one. I’m supposed to be a computer geek but the minimal interface of the metro OneNote just feels right. I hope they add pass option to the metro one.

          Once again, thanks.

  • http://forradalmargeci.tumblr.com/ Mark Tremmel

    But what about expanding the functions for the Windows Phone?

  • Willem Evenhuis

    Which onenote do they mean? OneNote for the windows desktop 2013, OneNote app for the modern UI, onenote for windows phone? Most of these features are already available to some degree within the onenote desktop program. If this refers to onenote for windows phone, this would be great! Still missing one important api for me in this app: instant ink-to-text recognition of handwriting input. Already avialble in onenote 2013 as an edit option. But would like it to be a more seamless experience with also multiple language pack support, as like myscript mobile. Microsoft has supported ink-to-text recognition for so long now. I amazed this feature doesnt get the support it deserves.

    • Bugbog

      I’m fairly certain it’s for mobile apps. As you’ve indicated the desktop API’s are already almost fully featured.