How to (OneNote API)
You can find assorted coding tips and tricks for using the Microsoft OneNote API here.
Last modified: April 30, 2014
Applies to: OneNote service
Wondering why you don't see your platform called out? That's because each of the How To's give information about the different platforms together. We did that so if you're writing a multi-platform app, you can easily compare the code side-by-side. If you're not using one of the platforms we have code examples for, let us know, and in the meantime check out the REST information.
If there's something you don't see and want it, feel free to share your ideas in the communities, listed at the bottom. If you just want a step-by-step run through a "Hello World" application, check out the tutorials in the Getting started with the OneNote API section.
These How To's give more details about things you might need you start using the API:
Get a client ID for use with the OneNote API
Gives you the details about how to use your Microsoft Account to get the client IDs that identify your app to the OneNote.
Get tools and libraries to use with the OneNote API
Lists the essential and cool libraries we've been using to make coding to the API fast and easy.
Get the OneNote API sample applications
Has links and descriptions of our sample apps on GitHub. Using them as a starting point is often the fastest and easiest way to start using the API.
These How-To's are things that most if not all apps will have to do; things like authentication, handling errors, and so on:
Authenticate the user for the OneNote API
Shows you how to use the Windows Live Connect SDK to get the OAuth tokens that tie together user's permission for your app to access their OneNote data.
Debug and handle errors with the OneNote API
Shows how to code the exception handling for errors returned by the API, and what those errors mean to your app.
Open the OneNote clients with the OneNote API
Provides platform-specific code for using the links the API returns that point to a specific location in the user's OneNote notebook.
These How-To's describe how to use the API in your app to work with OneNote:
Creating content in OneNote
Make simple captures with the OneNote API
Shows how to create simple OneNote pages by sending HTML in the body of the request.
Create structure using HTML with the OneNote API
Shows how to create OneNote pages using more-complex multi-part POSTs and HTML.
Capture photos and images with the OneNote API
Shows how to include image data directly in the POST request for app that need to send the image data directly from the device.
Capture web page snapshots with the OneNote API
Shows how to have the API render publicly-visible web pages as snapshot images and save the images on the OneNote page.
Capture embedded files with the OneNote API
Shows how to have OneNote store binary file data as an embedded file on the page.
Capture and embed PDF files with the OneNote API
Shows how to include PDF files so they appear as both embedded files, and display the PDF document pages as images.
Capture pages in a specific section using the OneNote API
Shows how to specify a named OneNote notebook section where the captured pages get put.
We want to hear from you, we want you to know what's going on, and get the help you need. You can catch up by visiting these sites:
Dev.OneNote.com web site is our main entry point to the world of API.
OneNote dev center featured apps showcases successful apps.
OneNote API blog carries our announcements, information about updates, and articles to help you learn more and get more done with the API.
StackOverflow Q&A has conversations about developing with the OneNote API.
API Feedback site lets you tell us what you think about the API.