Export (0) Print
Expand All

Get a client ID for use with the OneNote API

The Microsoft OneNote API uses OAuth 2.0 to ensure the app has the user's permission to access their Microsoft OneDrive-hosted OneNote notebook. An important step in developing your app, on any platform or in any language, is obtaining a client ID (or, a package identity for a Windows Store app). Follow these steps to identify your app to the Live service, and configure your apps.

Last modified: October 27, 2014

Applies to: OneNote service

In this article
Sign-up for a Microsoft Account
Get a new client ID for Android, iOS, and Windows Phone apps
Get a new package identity for Windows Store apps
More information

To use the OneNote API in your app, you need to use the Microsoft Live service to identify your app and let your users authorize access to their notebooks. The platform that you're targeting determines how you integrate the Live service.

If you're developing …

You'll need to have a…

So you can get your…

Android, iOS or Windows Phone apps

Microsoft Account

Client ID

Windows Store apps

Microsoft Account registered as a Windows Store developer account (see Account types, locations, and fees)

Package identity

Other types of application, like Windows 7 or 8 desktop applications, Web-based apps, Web sites, services, and so on

Microsoft Account

Client ID, client secret, and optionally set a redirect domain

Expand the sections below for platform-specific details.

To manage the OAuth client IDs and package identities, you first need to have a Microsoft account. To create a new Microsoft account, see https://signup.live.com/signup.aspx.

We recommend that you associate that Microsoft account with an existing email address that you check regularly. We might try and contact you at that address to highlight your app on the Featured Apps page, or if we notice unexpected network traffic coming from your app. We will not spam you or sell your information.

A client ID connects your Microsoft account and email address to your apps and tells the OneNote that the user has authorized your app to access their data.

Tip Tip

Windows Store applications use a package identity instead of a client ID. If you're building a Windows Store app, follow the instructions in the next section instead of this one.

To get a new client ID for use with Android, iOS and Windows Phone apps, follow these steps:

  1. Visit the Live app management site, and log in using your Microsoft account.

  2. Choose Create application.

  3. Enter an Application name that will be visible to users when they consent to giving it access. Also set the primary language you plan to use for the app.

  4. If you accept the terms of use and Privacy & Cookies policy, choose I accept.

  5. The app settings page displays the client ID string that you'll use in your app.

Once created, use the client ID string in your app, as described in Authenticate the user for the OneNote API. As you continue developing your app, be sure to go back to the My Applications area and adjust the other settings as appropriate.

For more information, see Configuring your app on the Live Connect Developer Center.

Before you can publish a Windows Store app that uses the Live service with the OneNote API, you need to have a Windows Store developer account. You can learn about Windows Store developer accounts in the MSDN Windows Dev Center for Windows Store apps.

Tip Tip

Only Windows Store applications require a developer account and package identity. If you're not developing a Windows Store app, you don't need to perform the steps in this section. Instead, use the steps in the preceding section to get a client ID, and optionally the steps after this section to get a client secret and set the redirect domain.

After you have your developer account setup, you tell the Live service about your app by creating a package identity. A package identity is essentially the combination of a verified developer account and the registered app name. By tying the package identity to your developer account, the service ensures that a known Microsoft Account is associated with the app. Then, when your app later identifies itself for publishing, user-installation, and authorization, the Live service and the Windows Store recognizes which app is calling, and who is responsible for it.

To get a new package identity, follow these steps:

  1. Visit your Windows Store Dashboard. If the site asks you to log-in, provide your developer account username and password.

  2. To add a new app, choose Submit an app, then App name, and follow the on-screen directions to name your app. Save the changes to return to the app summary page.

  3. If this is an existing app, select it and choose Edit.

  4. The OneNote API requires your app to use HTTPS, so you will need to answer "Yes" on the Cryptography page.

  5. Fill out the other information for your app as described on the pages.

  6. Choose Save.

The preceding instructions are also available on the Configuring your app page in the Live Connect Developer Center.

For more in-depth information visit Configuring your app in the Live Connect Developer Center documentation.

© 2014 Microsoft