Table of contents
TOC
Collapse the table of content
Expand the table of content
Última actualización: 20/06/2018

Desarrollo en OneNote

Se aplica a: blocs de notas para consumidores de OneDrive | blocs de notas corporativos de Office 365

OneNote es una herramienta popular para tomar notas que está disponible en línea y en muchas plataformas móviles y de tableta. Con la integración de sus aplicaciones con OneNote, resulta más fácil que nunca crear aplicaciones eficaces en sus plataformas favoritas y llegar a millones de usuarios en todo el mundo.

Ejemplo de página de OneNote.

Aproveche la jerarquía de blocs de notas, secciones y páginas de OneNote y la API fácil de usar para ayudar a sus usuarios a planificar y organizar ideas e información.

Nota: Cuando utiliza la API de OneNote, acepta los términos de uso de las API de Microsoft.

Información general sobre la plataforma

El servicio OneNote se ejecuta en la nube de Microsoft y proporciona una interfaz RESTful para el acceso programático al contenido de OneNote. La API de OneNote es ligera y simple: se basa en JSON, HTML y OData, por lo que puede utilizarla con cualquier idioma o plataforma que admita solicitudes HTTP.

A continuación se muestra una vista simple de la pila de desarrollo de la API de OneNote.

Paquete de desarrollo para aplicaciones de OneNote en distintas plataformas. Las aplicaciones utilizan OAuth 2.0 para acceder al contenido de OneNote.

En primer lugar, su usuario debe estar autenticado y tener concedido el acceso a su aplicación. A continuación, debe obtener un token de acceso que utiliza para interactuar con el contenido de OneNote. Además del soporte de CRUD para los recursos de OneNote, la API proporciona también funcionalidades tales como reconocimiento óptico de caracteres (OCR), búsqueda de texto completo y extracciones de tarjetas de presentación.

Puede utilizar los SDK para simplificar el proceso de autenticación.

Utilizar la API de OneNote

Para utilizar la API de OneNote, debe enviar solicitudes HTTP a extremos específicos fuera de la URL raíz del servicio de OneNote:

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

Puede utilizar la API de OneNote para realizar acciones como crear, ver y administrar páginas en blocs de notas personales, de sitios y de grupos. Para darle una idea de cómo funciona la API, a continuación se muestra una solicitud POST simple que crea una página en el bloc de notas predeterminado del usuario actual.

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>

Si el resultado es correcto, la solicitud devuelve la siguiente respuesta: en este caso, una representación de OData de la nueva página en formato 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"
}

Consulte Crear páginas para ver con más detalle las solicitudes POST pages.

¿Para qué crear aplicaciones de OneNote?

Integre OneNote para crear aplicaciones que van a entusiasmar. Puede utilizar la API de OneNote para crear y administrar notas, listas, imágenes, archivos y mucho más en blocs de notas de OneNote.

Recopilar y organizar notas e ideas
Utilice OneNote como un lienzo donde los usuarios pueden agregar y organizar su contenido. La API de OneNote hace que sea más fácil escribir aplicaciones para que los estudiantes puedan tomar notas e investigar, las familias compartan planes e ideas, los compradores compartan imágenes, etc. Todo lo que más les interesa. Su aplicación puede obtener la información que se desea, enviarla a OneNote y a continuación ayudarles a organizarla.

Capturar la información en varios formatos
Capture HTML, inserte imágenes (de una ubicación local o de una URL pública), vídeo, audio, mensajes de correo electrónico y otros tipos de archivo comunes. OneNote incluso puede presentar páginas web y archivos PDF como instantáneas. La API de OneNote admite un conjunto de HTML y CSS estándar para el diseño de página de OneNote, así que puede utilizar tablas, imágenes insertadas y formato básico para conseguir el aspecto que desea.

Utilice el ecosistema de OneNote para mejorar sus escenarios básicos
Aproveche otras potentes características de OneNote. La API ejecuta OCR en imágenes, admite la búsqueda de texto completo, sincroniza automáticamente clientes, procesa imágenes y extrae capturas de tarjetas de presentación y listas de productos y recetas en línea. Utilice OneNote como almacén de memoria digital en la nube para notas y elementos multimedia ligeros, o como fuente de datos para datos específicos de dominio.

Llegue a millones de usuarios de OneNote en todas las plataformas principales
Utilice OneNote para aumentar el uso de su aplicación. Preinstalada en los nuevos dispositivos Windows, disponible para plataformas populares, en la web como OneNote Online y parte de Oficina 365- Más de 100 millones de personas en todo el mundo utilizan activamente OneNote. Cuando publica aplicaciones que aprovechan el entorno OneNote rico en funciones, el potencial del mercado multiplataforma es simplemente demasiado grande para pasarlo por alto.

Comience con la API de OneNote

Utilice ejemplos y tutoriales para comenzar a programar rápidamente, pruebe nuestras consolas interactivas o profundice más con nuestra documentación.

Ejemplos y tutoriales de OneNote

Estos ejemplos y tutoriales muestran los conceptos básicos del uso de la API de OneNote en distintas plataformas. (Vea todos nuestros ejemplos en GitHub.)

* MSA = autenticación de cuenta de Microsoft, AAD = autenticación de Azure Active Directory

Consolas interactivas

Utilice una de nuestras consolas interactivas para probar la API de OneNote con sus propios blocs de notas de OneNote.

Referencia REST interactiva

Referencia REST interactiva

(1) Elija un extremo, (2) haga clic en el mosaico del método y a continuación (3) elija ** Cambiar a consola** y autentíquese con sus credenciales de cuenta de Microsoft. Cambie las opciones de cadena de consulta de ejemplo según sea necesario y elija Llamar al recurso.


OneNote en Apigee

OneNote en Apigee

(1) Elija ** Concesión implícita de OAuth 2** en el menú desplegable y autentíquese con sus credenciales de cuenta de Microsoft, y, a continuación, (2) elija un extremo. Especifique valores en las pestañas Consulta, Plantilla y Encabezado según sea necesario, y (3) elija Enviar.

Artículos prácticos y conceptuales

Cuando esté listo para profundizar más, explore nuestros artículos prácticos y conceptuales para obtener más información sobre lo que puede hacer con OneNote.

Autenticación y permisos

Criterios para la personalización de marca

Operaciones REST admitidas

Obtener el contenido y la estructura de OneNote

Abrir los clientes de OneNote

Copiar blocs de notas, secciones y páginas

Crear páginas

Actualizar contenido de la página

Agregar imágenes, vídeos y archivos

Crear elementos con posición absoluta

Extraer datos

Utilizar etiquetas de nota

Administrar permisos en entidades de OneNote

Trabajar con blocs de notas de clase

Trabajar con cuadernos de personal

HTML de entrada y salida

Códigos de error y de advertencia

Utilizar el diálogo Guardar

Suscribirse para webhooks

SDK para el desarrollo en OneNote

Las aplicaciones de OneNote pueden usar el SDK de la API de OneDrive para obtener los tokens de acceso necesarios para todas las solicitudes a la API de OneNote. El SDK hace que la autenticación sea más fácil para usted. Solo tiene que proporcionar su información de identidad e integrar algunas llamadas, y el SDK se ocupará de todo, desde el inicio de sesión hasta el consentimiento para obtener, almacenar y actualizar tokens. A continuación, podrá realizar llamadas REST a la API de OneNote. Nuestro tutorial de iOS muestra cómo puede usar el SDK en una aplicación de OneNote.

Todas las versiones del SDK admiten la autenticación de cuentas de Microsoft (para blocs de notas de consumidor) y algunas también son compatibles con Azure Active Directory (para blocs de notas de empresa). Consulte la documentación de OneDrive para obtener la lista actual de plataformas compatibles.

El SDK de la API de OneDrive reemplaza al SDK de Live. El SDK de Live está obsoleto, pero seguirá siendo compatible con las aplicaciones de OneNote existentes que lo utilicen. Para un desarrollo nuevo, use el SDK de la API de OneDrive.

En el futuro puede que proporcionemos bibliotecas que a la vez gestionen la autenticación y admitan llamadas nativas a la API de OneNote, pero por ahora puede usar el SDK de la API de OneDrive.

Como alternativa, las aplicaciones empresariales pueden usar la Biblioteca de autenticación de Active Directory (ADAL) para acceder a Office 365 y a los blocs de notas alojados en SharePoint. Puede considerar el uso de ADAL directamente si no hay un SDK disponible para su plataforma o si desea tener más control sobre el proceso de autenticación. Nuestro tutorial de ASP.NET MVC muestra cómo puede usar ADAL en una aplicación de OneNote.

¡Importante! Para interactuar con el contenido y los recursos de OneNote, siempre debe usar la API de OneNote. No use la API de OneDrive.

Comuníquese con nosotros

Esté atento a medida que nos expandimos y mejoramos. Siempre deseamos escuchar sus preguntas y comentarios, ayudarlo a resolver sus dudas y mantenerlo informado. Puede contactar con nosotros de la siguiente manera:

Qué ha cambiado

Las siguientes entradas resaltan los cambios realizados en la API y la documentación de OneNote durante el año pasado:

Febrero de 2017

Se han agregado el tema Autenticación de OneNote y permisos de la aplicación de AzureAD.

Julio de 2016

Se ha agregado el tema Trabajar con cuadernos de personal.

Se ha documentado el soporte de vídeos integrados.

Mayo de 2016

Se ha agregado soporte de vista previa de página. Utilice el extremo ../pages/{id}/preview para obtener contenido de vista previa de texto e imagen de una página. Lea la entrada del blog API de vista previa de página para obtener más información.

Se ha documentado el soporte de la ubicación ../users/{id}/notes/, que permite el acceso al contenido de OneNote que el usuario especificado (en la URL) ha compartido con el usuario actual. Solo blocs de notas corporativos.

Se han agregado API de administración de permisos que le permiten establecer permisos de acceso en un bloc de notas, grupo de sección o sección. Solo blocs de notas corporativos.

Se han agregado nuevas operaciones de bloc de notas de clase: Insertar secciones de otros blocs de notas, Agregar un grupo de sección Solo profesor, Eliminar blocs de notas de clase, Crear blocs de notas de clase en un idioma específico, Enviar una notificación por correo electrónico para un nuevo bloc de notas de clase. Solo blocs de notas corporativos.

Se ha agregado soporte para

element in page HTML content. Now, content captured from sites like MSDN and StackOverflow renders with proper code formatting.</p>
<p id="outdent">Marzo de 2016</p>
<p id="indent">Se ha lanzadoGET /pages/{id}/content?preAuthenticated=truea producción. Cuando se utiliza la opción de cadena de consultapreAuthenticated=truepara recuperar el contenido de la página, el [HTML de salida](../howto/onenote-input-output-html.md#image-output-examples) incluye URL públicas a los recursos de imagen en la página. Estas URL preautentificadas son válidas durante una hora. Consulte [Autenticación única para recursos públicos](https://blogs.msdn.microsoft.com/onenotedev/2016/03/22/693/).</p>
<p id="indent">Se ha lanzadoPATCH /sections/{id}a producción. Esto le permite cambiar el nombre de una sección enviando un tipo de contenido *aplication / json* en el cuerpo del mensaje, de la forma siguiente:{ "name": "New section name" }</p>
<p id="outdent">Febrero de 2016</p>
<p id="indent">Se han agregado los temas [Suscribirse para webhooks](../howto/onenote-sync.md) y [Trabajar con blocs de notas de clase](../howto/onenote-classnotebook.md). Actualmente, los webhooks solo son compatibles con blocs de notas de consumidores en OneDrive.</p>
<p id="outdent">Enero de 2016</p>
<p id="indent">Se ha activado el límite. Obtenga más información sobre el [limite de la API de OneNote y los procedimientos recomendados para evitarlo](http://blogs.msdn.com/b/onenotedev/archive/2016/01/13/onenote-api-throttling-and-best-practices.aspx).</p>
<p id="indent">Se han agregado los temas [Operaciones REST admitidas](../howto/onenote-supported-ops.md) y [Copiar blocs de notas, secciones y páginas](../howto/onenote-copy.md). La funcionalidad de copia está actualmente disponible solo para blocs de notas de Office 365.</p>
<p id="outdent">Noviembre de 2015</p>
<p id="indent">El soporte de los blocs de notas de Office 365 ha pasado de versión preliminar a producción. Incluye soporte para blocs de notas en sitios de SharePoint y grupos de Office 365, y se requieren los permisos **Notes.Read.All** y **Notes.ReadWrite.All** para acceder a estos blocs de notas a nivel de organización.</p>
<p id="indent">Se ha lanzadoPOST /sectiongroups/{id}/sections,POST /notebooks/{id}/sectiongroupsyPOST /sectiongroups/{id}/sectiongroupsa producción.</p>
<p id="indent">Se ha lanzado **CopyNotebook**, **CopyToNotebook**, **CopyToSectionGroup**, **CopyToSection** a producción para los blocs de notas de Office 365.</p>
<p id="indent">Se han agregado las propiedades de navegación **parentSection** y **parentNotebook** a las páginas. La consultaGET pagespredeterminada expande **parentSection** y selecciona las propiedades **name**, **id**y **self** de la sección.</p>
<p id="indent">Se han agregado las propiedades **level** y **orden** a las páginas. Para recuperar estas propiedades, incluya el parámetro **pagelevel** en una consulta para la colección de páginas en una sección o para una página específica. Por ejemplo,GET ../sections/{id}/pages?pagelevel=trueoGET ../pages/{id}?pagelevel=true</p>
<p id="indent">El número máximo de caracteres en el nombre de un bloc de notas ha cambiado de 50 a 128.</p>
<p id="indent">Se ha movido la documentación práctica y conceptual. La nueva documentación trata de las API de OneNote de los consumidores y corporativas.</p>
<p id="outdent">Septiembre de 2015</p>
<p id="indent">El número máximo de páginas devueltas en una solicitudGET pagescon la opción de cadena de consulta**top** ha cambiado de 500 a 100.</p>
<p id="outdent">Julio de 2015</p>
<p id="indent">Se han lanzado de dos aplicaciones de ejemplo del explorador de la API REST de OneNote:<br />- [Explorador de API REST de iOS](https://github.com/OneNoteDev/iOS-REST-API-Explorer)<br />- [Explorador de API REST de Android](https://github.com/OneNoteDev/Android-REST-API-Explorer)</p>
<p id="indent">Se ha lanzadoDELETE pagesa producción.</p>
<p id="indent">Se ha actualizado la URL del servicio raíz en los temas de procedimientos para utilizar la nueva ruta recomendada/me/notes/:https://www.onenote.com/api/v1.0/me/notes/`

Junio de 2015

Publicado el tema Usar etiquetas de nota.

Recursos adicionales

© 2018 Microsoft