#OneNote API Ruby on Rails Sample README
Created by Microsoft Corporation, 2014. Provided As-is without warranty. Trademarks mentioned here are the property of their owners.
###API functionality demonstrated in this sample This sample illustrates how to use the OneNote REST API for the following use cases:
- Log-in the user
- POST simple HTML to a new OneNote QuickNotes page
- POST multi-part message with image data included in the request
- POST page with a URL rendered as an image
- POST page with HTML rendered as an image
- POST page with a PDF file rendered and attached
- Extract the returned oneNoteClientURL and oneNoteWebURL links
#####Tools and Libraries
You will need to download, install, and configure for your Ruby on Rails development environment. If you are new to Ruby on Rails, please go to http://rubyonrails.org/download to get started.
Once you have your Ruby on Rails environment up and running, be sure to verify the prerequisites for these too (in Gemfile for yours app).
- gem 'jquery-rails'
- gem 'rest-client'
- gem 'rest-client-multipart'
You also need a normal URL with hostname (not just an IP address) to use for the Redirect URL. If you run this from your own desktop, you'll need to modify your Hosts file (in C:\Windows\System32\drivers\etc for Windows machines and /private/etc for Macs) and map your local server IP address to a new domain name, as in the following example.
As the developer, you'll need to have a Microsoft account and get a client ID so your app can authenticate with the Microsoft Live connect services.
###Using the sample###
After you've setup your development tools, and installed the prerequisites listed above,....
- Download the repo as a ZIP file to your local computer, and extract the files. Or, clone the repository into a local copy of Git.
- Go to the Microsoft app registration page.
- On the API Settings page, set Mobile or desktop setting to No.
- Set the Redirect URI to the domain name of your web site, as in the following example. The root domain name must be unique, so if you use one domain for testing and another for production, you'll need to register separate client ids and secrets for each domain.
- On the App Setting page, copy the client ID and secret into the config/onenote.yml file.
- Build and run the Ruby on rails app.
- Open a browser and navigate to the app running by default on port 3000.
- Login using your Microsoft account, and allow the app to create pages in your OneNote notebooks.
This is the initial public release for this code sample.
- Visit the dev.onenote.com Dev Center
- Contact us on StackOverflow (tagged OneNote)
- Follow us on Twitter @onenotedev
- Read our OneNote Developer blog
- Explore the API using the apigee.com interactive console. Also, see the short overview/tutorial.
- API Reference documentation
- Debugging / Troubleshooting
- Getting Started with the OneNote API