Développement OneNote

  • Article

**S’applique à ** blocs-notes consommateur sur OneDrive | Blocs-notes d’entreprise sur Office 365

OneNote est un outil de prise de notes populaire disponible en ligne et sur de nombreuses plateformes mobiles et tablettes. En intégrant vos applications à OneNote, il est plus facile que jamais de créer des applications puissantes sur vos plates-formes préférées et d'atteindre des millions d'utilisateurs dans le monde entier.

Un exemple de page OneNote.

Tirez parti de la hiérarchie des cahiers, des sections et des pages de OneNote et de l'API facile à utiliser pour aider vos utilisateurs à planifier et à organiser leurs idées et leurs informations.

Notes

Lorsque vous utilisez l’API OneNote, vous acceptez lesconditions d’utilisation de l’API Microsoft.

Vue d’ensemble de la plateforme

Le service OneNote s'exécute sur le cloud Microsoft et fournit une interface RESTful pour l'accès par programmation au contenu OneNote. L’API OneNote est légère et simple —elle est basée sur JSON, HTML et OData, vous pouvez donc l’utiliser avec n’importe quel langage ou plate-forme prenant en charge les requêtes HTTP.

Voici une vue simple de la pile de développement de l'API OneNote.

Pile de développement pour les applications OneNote sur diverses plates-formes. Les applications utilisent OAuth 2.0 pour accéder au contenu OneNote.

Tout d'abord, votre utilisateur doit être authentifié et accorder l'accès à votre application. Ensuite, vous obtenez un jeton d'accès que vous utilisez pour interagir avec le contenu OneNote. En plus de la prise en charge de CRUD pour les ressources OneNote, l'API fournit également des fonctionnalités telles que la reconnaissance optique de caractères (OCR), la recherche de texte intégral et les extractions de cartes de visite.

Conseil

Vous pouvez utiliser SDK pour simplifier le processus d'autorisation.

Utilisation de l'API OneNote

Pour utiliser l'API OneNote, vous envoyez des demandes HTTP à des points de terminaison spécifiques à partir de l'URL racine du service de OneNote :

https://www.onenote.com/api/{version}/{location}/notes/...

Vous pouvez utiliser l'API OneNote pour créer, afficher et gérer des pages dans des blocs-notes personnels, de site et de groupe. Pour vous donner une idée du fonctionnement de l'API, voici une simple requête POST qui crée une page dans le bloc-notes par défaut de l'utilisateur actuel.

POST https://www.onenote.com/api/v1.0/me/notes/pages

Authorization: Bearer {token}
Content-Type: text/html; charset=utf-8
Accept: application/json
 ...

<!DOCTYPE html>
<html>
    <head>
    <title>My new OneNote page</title>
    <meta name="created" content="2015-09-9T12:45:00.000-8:00"/>
    </head>
    <body>
        <p>This is a simple HTML page.</p>
    </body>
</html>

En cas de succès, la requête renvoie la réponse suivante —dans ce cas, une représentation OData de la nouvelle page au format JSON.

HTTP/1.1 201 Created
Location:https://www.onenote.com/api/v1.0/me/notes/pages/0-37e6dad...
X-CorrelationId:8943c159-ee49-4c71-8cd0-ebf0861d07a6
Date:Sun, 09 Aug 2015 21:36:40 GMT
Content-Type:application/json; odata.metadata=minimal; odata.streaming=true
 ...

{
  "@odata.context": "https://www.onenote.com/api/v1.0/$metadata#me/notes/pages/$entity",
  "title": "My new OneNote page",
  "createdByAppId": "WLID-0000000048219837",
  "links": {
    "oneNoteClientUrl": {
      "href": "onenote:https://d.docs.live.net/73dbaf9b..."
    },
    "oneNoteWebUrl": {
      "href": "https://onedrive.live.com/redir.aspx?cid=73dbaf9b..."
    }
  },
  "contentUrl": "https://www.onenote.com/api/v1.0/me/notes/pages/0-37e6dad.../content",
  "lastModifiedTime": "2015-09-09T12:45:00Z",
  "id": "0-37e6dad8c6eb489294656ad878431666!209-73DBAF9B7E5C4B4C!153",
  "self": "https://www.onenote.com/api/v1.0/me/notes/pages/0-37e6dad...",
  "createdTime": "2015-09-09T12:45:00Z"
}

Voir Créer des pages pour plus d'informations sur les demandes POST pages.

Pourquoi créer des applications OneNote ?

Intégrez OneNote pour créer des applications que les gens vont adorer. Vous pouvez utiliser l’API OneNote pour créer et gérer des notes, listes, photos, fichiers et autres éléments dans les blocs-notes OneNote.

Recueil et organisation de notes et d’idées

Utilisez OneNote comme un canevas dans lequel les utilisateurs peuvent ajouter et organiser leur contenu. L’API OneNote facilite l'écriture d'applications pour que les étudiants puissent prendre des notes et faire des recherches, que les familles partagent des idées et des plans, que les clients partagent des photos—toutes les choses qui intéressent le plus les gens. Votre application peut extraire les informations souhaitées, les envoyer à OneNote, puis aider les utilisateurs à les organiser.

Capture d’informations dans de nombreux formats

Capturez des fichiers HTML, incorporez des images (provenant de votre ordinateur ou d’une URL publique), des vidéos, des fichiers audio, des e-mails et d’autres types de fichiers courants. OneNote peut même afficher des pages web et des fichiers PDF sous forme de captures instantanées. L'API OneNote prend en charge un ensemble de HTML et de CSS standards pour la mise en page OneNote, ce qui vous permet d'utiliser des tableaux, des images en ligne et un formatage de base pour obtenir l'apparence souhaitée.

Utilisation de l’écosystème OneNote pour améliorer vos scénarios de base

Tirez parti des autres fonctionnalités utiles de OneNote. L'API exécute de l’OCR sur les images, prend en charge la recherche de texte intégrale, synchronise automatiquement les clients, traite les images et extrait les captures de cartes de visite et les référencements de produits et de recettes en ligne. Utilisez OneNote comme votre espace de stockage mémoire numérique dans le cloud pour des notes ou de petits fichiers multimédias, ou comme un flux de données pour des données propres à un domaine.

Un public élargi : des millions d’utilisateurs OneNote sur toutes les plateformes principales

Utilisez OneNote pour augmenter le nombre d’utilisateurs de votre application. Préinstallé sur les nouveaux appareils Windows, disponible pour les plates-formes populaires, sur le Web en tant que OneNote Online, et faisant partie de Office 365—100 millions de personnes dans le monde utilisent activement OneNote. Lorsque vous publiez des applications qui tirent parti de l'environnement OneNote riche en fonctionnalités, le potentiel du marché multiplateforme est tout simplement trop important pour être ignoré.

Premiers pas avec l'API OneNote

Utilisez des exemples et des didacticiels pour commencer à coder rapidement, essayez nos consoles interactives ou approfondissez notre documentation.

Échantillons et tutoriels OneNote

Ces didacticiels et exemples montrent les principes de base de l’utilisation de l’API OneNote sur différentes plateformes (consultez tous nosexemples sur GitHub).

Plate-forme Didacticiels et exemples
iOS iOS-REST-API-Explorer (MSA seulement)
Didacticiel
Windows OneNoteAPISampleWinUniversal
Android Android-REST-API-Explorer
PHP OneNoteAPISamplePHP (MSA seulement)
Node.js OneNoteAPISampleNodejs (MSA seulement)
Ruby OneNoteAPISampleRuby (MSA seulement)
ASP.NET MVC Didacticiel (Azure AD uniquement)
  • MSA = Authentification de compte Microsoft, AAD = Authentification Azure Active Directory

Articles pratiques et conceptuels

Lorsque vous êtes prêt à approfondir, parcourez nos articles pratiques et conceptuels pour en savoir plus sur ce que vous pouvez faire avec OneNote.

Les SDK pour le développement de OneNote

Les applications OneNote peuvent utiliser le kit de développement logiciel (SDK) de l’API OneDrive pour obtenir les jetons d’accès nécessaires pour toutes les demandes de OneNote API. Le SDK rend l’authentification plus facile pour vous. Vous fournissez simplement vos informations d’identité et intégrez quelques appels. Le SDK s’occupe alors de tout, de la connexion et consentement jusqu’à l’obtention, le stockage et le rafraîchissement des jetons. Ensuite, vous pouvez effectuer des appels REST à OneNote API. Notre didacticiel iOS montre comment vous pouvez utiliser le SDK dans une application OneNote.

Toutes les versions du SDK prennent en charge l’authentification de compte Microsoft (pour les blocs-notes grand public) et certaines prennent également en charge Azure Active Directory (pour les blocs-notes portables d’entreprise). Référez-vous à la documentation OneDrive pour la liste actuelle des plateformes prises en charge.

Notes

Le SDK de l’API OneDrive remplace le SDK Live. Le SDK Live est obsolète mais continuera à prendre en charge les applications OneNote existantes qui l’utilisent. Pour un nouveau développement, utilisez le SDK de l’API OneDrive.

Il est possible qu’à un moment donné, nous proposions des bibliothèques qui gèrent à la fois l’authentification et les appels natifs vers OneNote API, mais pour l’instant, vous pouvez utiliser le SDK de l’API OneDrive.

Une autre solution pour les applications d’entreprise consiste à utiliser la Bibliothèque d’authentification Active Directory (ADAL) pour accéder aux blocs-notes Office 365 et hébergés par SharePoint. Vous pouvez envisager d’utiliser ADAL directement s’il n'y a pas de SDK disponible pour votre plateforme ou si vous souhaitez plus de contrôle sur le processus d’authentification. Notre didacticiel ASP.NET MVC montre comment vous pouvez utiliser ADAL dans une application OneNote.

Important

Pour interagir avec le contenu et les ressources OneNote, vous devez toujours utiliser OneNote API. N’utilisez pas l’API OneDrive.

Pour plus d’informations, voir les ressources de OneNote.

Contactez-nous

Restez à l'écoute pendant que nous développons et améliorons. Nous souhaitons toujours entendre vos questions et commentaires, vous aider à comprendre les choses et vous tenir au courant. Voici comment vous pouvez vous connecter avec nous :

Qu'est-ce qui a changé

Les entrées suivantes mettent en évidence les modifications apportées à l'API OneNote et à la documentation au cours de l'année écoulée :

Juillet 2016

Mai 2016

Mars 2016

  • Sortie de GET /pages/{id}/content?preAuthenticated=true en production. Quand l' preAuthenticated=true option de chaîne de requête est utilisée pour récupérer le contenu de la page, le HTML de sortie inclut les URL publiques aux ressources d'image sur la page. Ces URL pré-authentifiées sont valides pendant une heure. Voir Authentification unique pour les ressources publiques.
  • Sortie de PATCH /sections/{id} en production. Cela vous permet de renommer une section en envoyant un type de contenu application / json dans le corps du message, comme ceci : { "name": "New section name" }

Février 2016

Janvier 2016

Novembre 2015

  • La prise en charge des blocs-notes Office 365 est passée de l'aperçu à la production. Inclut l’assistance pour les bloc-notes sur les sites SharePoint et les groupes Office 365, ainsi que les autorisations Notes.Read.All et Notes.ReadWrite.All requises pour accéder à ces bloc-notes au niveau de l'organisation.
  • SortiPOST /sectiongroups/{id}/sections, POST /notebooks/{id}/sectiongroups, et POST /sectiongroups/{id}/sectiongroups à la production.
  • Sorti CopyNotebook, CopyToNotebook, CopyToSectionGroup, CopyToSection à la production pour les bloc-notes Office 365.
  • Ajout des propriétés de navigationparentSection et ParentNotebook aux pages. La requête par défaut GET pages se développe parentSection et sélectionne l'ID du nom, de la section, et les propriétés propres.
  • Ajouté le niveau et commande propriétés aux pages. Pour récupérer ces propriétés, incluez le paramètrepagelevel dans une requête pour la collection de pages dans une section ou pour une page spécifique. Exemple : GET ../sections/{id}/pages?pagelevel=true ou GET ../pages/{id}?pagelevel=true
  • Le nombre maximal de caractères dans un nom de bloc-notes est passé de 50 à 128.
  • Déplacement de la documentation pratique et conceptuelle. La nouvelle documentation couvre les API OneNote grand public et d'entreprise.

Septembre 2015

  • Le nombre maximal de pages renvoyées dans une requête GET pages à l’aide de l’option de chaîne de requête top passée de 500 à 100.

Juillet 2015

  • Lancement de applications d’exemple d’exploration de l’API REST OneNote :
    - Explorateur d'API iOS REST
    - Explorateur d'API REST Android
  • SortiDELETE pages à la production.
  • Mise à jour de l’URL du service racine dans les rubriques de procédure pour utiliser la nouvelle route /me/notes/ recommandée : https://www.onenote.com/api/v1.0/me/notes/

Juin 2015

Voir aussi