Desarrollo de OneNote

  • Artículo

Se aplica a: Blocs de notas para consumidores de OneDrive | Blocs de notas empresariales 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.

Sugerencia

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 puntos de conexión 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

Use 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, que las familias compartan planes e ideas, que los compradores compartan imágenes, etc.—todo lo que más le interesa a la gente. Su aplicación puede obtener la información que la gente quiere, enviarla a OneNote y luego ayudarles a organizarla.

Capturar la información en varios formatos

Captura de HTML, imágenes insertadas (originadas localmente o en una dirección URL pública), vídeo, audio, mensajes de correo electrónico y otros tipos de archivo comunes. OneNote puede incluso 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.

Usar el ecosistema de OneNote para mejorar los escenarios básicos

Aproveche otras potentes características de la API 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. Use 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.

Llegar 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 Office 365—Más de 100 millones de personas en todo el mundo utilizan activamente OneNote. Cuando publica aplicaciones que aprovechan un entorno tan rico en funcionalidades como el de OneNote, 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 aspectos básicos del uso de la API de OneNote en distintas plataformas (vea nuestros ejemplos en GitHub).

Plataforma Ejemplos y tutoriales
iOS iOS-REST-API-Explorer (solo MSA)
Tutorial
Windows OneNoteAPISampleWinUniversal
Android Android-REST-API-Explorer
PHP OneNoteAPISamplePHP (solo MSA)
Node.js OneNoteAPISampleNodejs (solo MSA)
Ruby OneNoteAPISampleRuby (solo MSA)
ASP.NET MVC Tutorial (solo Azure AD)

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

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.

Paquetes de desarrollo para 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.

Nota

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.

Para obtener más información, vea Recursos de OneNote.

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:

Julio de 2016

Mayo de 2016

Marzo de 2016

  • Se ha lanzado GET /pages/{id}/content?preAuthenticated=true a producción. Cuando se utiliza la opción de cadena de consulta preAuthenticated=true para recuperar el contenido de la página, el HTML de salida 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.
  • Se ha lanzado PATCH /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" }

Febrero de 2016

Enero de 2016

Noviembre de 2015

  • 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.
  • Se ha lanzado POST /sectiongroups/{id}/sections, POST /notebooks/{id}/sectiongroups y POST /sectiongroups/{id}/sectiongroups a producción.
  • Se ha lanzado CopyNotebook, CopyToNotebook, CopyToSectionGroup, CopyToSection a producción para los blocs de notas de Office 365.
  • Se han agregado las propiedades de navegación parentSection y parentNotebook a las páginas. La consulta GET pages predeterminada expande parentSection y selecciona las propiedades name, idy self de la sección.
  • 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=true o GET ../pages/{id}?pagelevel=true
  • El número máximo de caracteres en el nombre de un bloc de notas ha cambiado de 50 a 128.
  • 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.

Septiembre de 2015

  • El número máximo de páginas devueltas en una solicitud GET pages con la opción de cadena de consulta top ha cambiado de 500 a 100.

Julio de 2015

  • Se han lanzado dos aplicaciones de ejemplo de exploración de la API de REST de OneNote:
    - Explorador de API REST de iOS
    - Explorador de API REST de Android
  • Se ha lanzado DELETE pages a producción.
  • 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

Vea también