Desenvolvimento do OneNote

  • Artigo

Aplica-se a: Blocos de anotações de consumidor no OneDrive | Blocos de anotações empresariais no Office 365

O OneNote é uma popular ferramenta de anotação que está disponível online e em diversas plataformas móveis e tablets. Ao integrar seus aplicativos ao OneNote, é muito fácil criar aplicativos capacitadores em suas plataformas favoritas e alcançar milhões de usuários em todo o mundo.

Uma página do OneNote de amostra.

Aproveite o bloco de anotações, as seções e a hierarquia de páginas do OneNote e a API fácil de usar para ajudar seus usuários a planejar e organizar ideias e informações.

Observação

Ao utilizar a API do OneNote, você concorda com os termos de uso da API da Microsoft.

Visão geral da plataforma

O serviço do OneNote é executado na nuvem da Microsoft e fornece uma interface RESTful para acesso programático ao conteúdo do OneNote. A API do OneNote é leve e simples—é construída em JSON, HTML e OData, para que você possa usá-la em qualquer linguagem ou plataforma que ofereça suporte a solicitações HTTP.

Aqui está uma visão simples da pilha de desenvolvimento da API do OneNote.

Pilha de desenvolvimento para aplicativos do OneNote em várias plataformas. Os aplicativos usam o OAuth 2.0 para acessar o conteúdo do OneNote.

Primeiro, seu usuário deve estar autenticado e o acesso deve ser concedido ao aplicativo. Em seguida, você obterá um token de acesso usado para interagir com o conteúdo do OneNote. Além do suporte a CRUD para recursos do OneNote, a API também oferece recursos como reconhecimento óptico de caracteres (OCR), pesquisa de texto completo e extrações de cartão de visita.

Dica

Você pode usar SDKs para simplificar o processo de autenticação.

Como usar a API do OneNote

Para usar a API do OneNote, você envia solicitações HTTP para pontos de extremidade específicos fora do URL raiz de serviço do OneNote:

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

É possível usar a API do OneNote para fazer coisas como criar, exibir e gerenciar páginas em blocos de anotações pessoais, de sites e de grupos. Para ter uma ideia de como a API funciona, veja essa solicitação POST simples que cria uma página no bloco de notas padrão do usuário atual.

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>

Se bem-sucedida, a solicitação retornará a seguinte resposta—nesse caso, uma representação OData da nova página no 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 Criar páginas para ver mais detalhes sobre solicitações de páginas de POST.

Por que criar aplicativos do OneNote?

Integre o OneNote para criar aplicativos que as pessoas vão adorar. Você pode usar a API do OneNote para criar e gerenciar anotações, listas, imagens, arquivos e muito mais em blocos de anotações do OneNote.

Coletar e organizar anotações e ideias

Use o OneNote com uma tela em que os usuários podem adicionar e organizar conteúdo. A API do OneNote facilita a criação de aplicativos para que os alunos possam tomar notas e fazer pesquisas, as famílias compartilhem planos e ideias, os compradores compartilhem fotos—tudo o que mais interessa às pessoas. O aplicativo pode obter as informações que as pessoas desejam, enviá-las ao OneNote e ajudar a organizá-las.

Capturar informações em muitos formatos

Capture HTML, insira imagens (originadas localmente ou em uma URL pública), vídeo, áudio, mensagens de email e outros tipos de arquivos comuns. O OneNote pode até mesmo renderizar páginas da Web e arquivos PDF como instantâneos. A API do OneNote oferece suporte a um conjunto de HTML e CSS padrão para layout de página do OneNote. Portanto, você pode usar tabelas, imagens embutidas e formatação básica para obter a aparência desejada.

Usar o ecossistema do OneNote para aprimorar seus cenários principais

Aproveite outros recursos poderosos da API do OneNote. A API executa OCR em imagens, oferece suporte a pesquisa de texto completo, sincroniza clientes automaticamente, processa imagens e extrai capturas de cartão de visita, listas de produtos e receitas online. Use o OneNote como seu repositório de memória digital na nuvem para anotações e mídia leve ou como um feed de dados para dados específicos de domínio.

Alcance milhares de usuários do OneNote em todas as principais plataformas

Use o OneNote para aumentar o uso do seu aplicativo. Pré-instalado em novos dispositivos Windows, disponível para plataformas populares, na Web como OneNote Online e como parte do Office 365—são mais de 100 milhões de pessoas em todo o mundo utilizando ativamente o OneNote. Quando você publica aplicativos que aproveitam o ambiente OneNote rico em recursos, o potencial de mercado de plataforma cruzada é simplesmente grande demais para ser ignorado.

Comece a usar a API do OneNote

Use exemplos e tutoriais para começar a codificar rapidamente, experimente nossos consoles interativos ou mergulhe mais fundo em nossa documentação.

Exemplos e tutoriais do OneNote

Esses exemplos e tutoriais mostram as Noções básicas do uso da API do OneNote em plataformas diferentes (consulte a todos os nossos exemplos no GitHub).

Plataforma Exemplos e tutoriais
iOS iOS-REST-API-Explorer (somente MSA)
Tutorial
Windows OneNoteAPISampleWinUniversal
Android Android-REST-API-Explorer
PHP OneNoteAPISamplePHP (somente MSA)
Node.js OneNoteAPISampleNodejs (somente MSA)
Ruby OneNoteAPISampleRuby (somente MSA)
ASP.NET MVC Tutorial (Somente AD do Azure)

*MSA = autenticação de conta da Microsoft, AAD = autenticação do Active Directory do Azure

Artigos de instruções e conceituais

Quando estiver pronto para obter detalhes, consulte nossos artigos de instruções e conceituais para saber mais sobre o que você pode fazer com o OneNote.

SDKs para o desenvolvimento do OneNote

Os aplicativos do OneNote podem usar o SDK da API do OneDrive para obter os tokens de acesso necessários para todas as solicitações à API do OneNote. O SDK torna a autenticação mais fácil para você. Basta fornecer os suas informações de identidade e integrar algumas chamadas que o SDK cuida de tudo, desde a entrada até consentimentos para obter, armazenar e atualizar tokens. Então, você pode fazer chamadas REST para a API do OneNote. O nosso tutorial para iOS mostra como você pode usar o SDK em um aplicativo do OneNote.

Todas as versões do SDK oferecem suporte à autenticação de conta da Microsoft (para blocos de anotações de consumidores) e algumas também oferecem suporte ao Active Directory do Azure (para blocos de anotações de empresas). Consulte a documentação do OneDrive para ver a lista atual de plataformas com suporte.

Observação

O SDK da API do OneDrive substitui o Live SDK. O Live SDK foi preterido, mas continuará oferecendo suporte aos aplicativos existentes do OneNote que o usam. Para novos desenvolvimentos, use o SDK da API do OneDrive.

Em algum momento, podemos fornecer bibliotecas que lidem com autenticação e ofereçam suporte a chamadas nativas para a API do OneNote, mas por enquanto você pode usar o SDK da API do OneDrive.

Como alternativa, os aplicativos corporativos podem usar a Biblioteca de Autenticação do Active Directory (ADAL) para acessar blocos de anotações hospedados no Office 365 e no SharePoint. Caso não haja nenhum SDK disponível para a sua plataforma ou se você quiser mais controle sobre o processo de autenticação, é possível usar a ADAL diretamente. O nosso tutorial do ASP.NET MVC mostra como você pode usar a ADAL em um aplicativo do OneNote.

Importante

Para interagir com conteúdos e recursos do OneNote, você deve sempre usar a API do OneNote. Não use a API do OneDrive.

Para obter mais informações, consulte recursos do OneNote.

Fale conosco

Fique atento conforme nos expandimos e melhoramos. Sempre queremos ouvir suas perguntas e comentários, ajudá-lo a descobrir as coisas e mantê-lo atualizado. Veja como você pode se conectar conosco:

O que mudou

As entradas a seguir destacam as alterações feitas na API do OneNote e na documentação durante o ano passado:

Julho de 2016

Maio de 2016

Março de 2016

  • Liberação do GET /pages/{id}/content?preAuthenticated=true para a produção. Quando a preAuthenticated=true opção de string de consulta é usada para recuperar o conteúdo da página, o HTML de saída inclui URLs públicos aos recursos de imagem na página. Esses URLs pré-autenticados são válidos por uma hora. Consulte Autenticação única para recurso público.
  • Liberação do PATCH /sections/{id} para a produção. Permite renomear uma seção enviando um tipo de conteúdo aplicativo/json no corpo da mensagem, dessa maneira: { "name": "New section name" }

fevereiro de 2016

janeiro de 2016

Novembro de 2015

  • Suporte para blocos de anotações do Office 365 movidos da pré-visualização para a produção. Inclui suporte para blocos de anotações em sites do SharePoint e grupos do Office 365, e as permissões Notes.Read.All e Notes.ReadWrite.All necessárias para acessar esses blocos no nível da organização.
  • Liberação do POST /sectiongroups/{id}/sections, POST /notebooks/{id}/sectiongroups e POST /sectiongroups/{id}/sectiongroups para a produção.
  • Liberação do CopyNotebook, CopyToNotebook, CopyToSectionGroup, CopyToSection para a produção em blocos de anotações do Office 365.
  • Adição das propriedades de navegação parentSection e parentNotebook nas páginas. A consulta GET pages padrão expande parentSection e seleciona as propriedades de nome, ide automáticas da seção.
  • Adição das propriedades nível e ordem nas páginas. Para recuperar essas propriedades, inclua o parâmetro pagelevel em uma consulta para a coleção de páginas em uma seção ou para uma página específica. Exemplo: GET ../sections/{id}/pages?pagelevel=true ou GET ../pages/{id}?pagelevel=true
  • O número máximo de caracteres em um nome de bloco de anotações mudou de 50 para 128.
  • Documentação conceitual e de instruções movida. A nova documentação abrange as APIs do OneNote de consumidor e empresarial.

Setembro de 2015

  • O número máximo de páginas retornadas em uma solicitação GET pages usando a principal opção de string de consulta foi alterada de 500 para 100.

Julho de 2015

  • Lançamento de dois aplicativos de exemplo do explorador da API REST do OneNote:
    - Explorador da API REST do iOS
    - Explorador da API REST para Android
  • Liberação do DELETE pages para produção.
  • Atualização do URL do serviço raiz nos tópicos de instruções para usar a rota nova recomendada /me/notes/: https://www.onenote.com/api/v1.0/me/notes/

Junho de 2015

Consulte também