Criar links de compartilhamento em entidades do OneNote
Aplica-se a: Blocos de anotações empresariais no Office 365
Criar um link de compartilhamento para compartilhar um arquivo do OneNote com qualquer pessoa. Você pode usar essa API para criar, obter e revogar links de convidado anônimo. Os links para convidados concederão permissões de edição ou permissões somente de visualização, sem a necessidade de fazer logon.
GET ../sectiongroups/{sectiongroup-id}/Microsoft.OneNote.Api.GetAnonymousSharingLink
POST ../sectiongroups/{sectiongroup-id}/Microsoft.OneNote.Api.GetOrCreateAnonymousSharingLink
DELETE ../sectiongroups/{sectiongroup-id}/Microsoft.OneNote.Api.RevokeAnonymousSharingLink
Observação
Os links de compartilhamento são suportados para bloco de anotações pessoais, de sites e de grupo do Office 365, mas não para bloco de anotações de consumidores no OneDrive. Neste momento, somente entidades de grupos de seção são suportadas atualmente.
Construir o URI de solicitação
Para criar o URI de solicitação, inicie com a URL raiz do serviço para a sua plataforma:
Blocos de anotações no OneDrive for Business
https://www.onenote.com/api/v1.0/me/notes/https://www.onenote.com/api/v1.0/users/{id}/notes/Blocos de anotações do site do SharePoint
https://www.onenote.com/api/v1.0/myOrganization/siteCollections/{id}/sites/{id}/notes/Blocos de anotações de grupo unificados
https://www.onenote.com/api/v1.0/myOrganization/groups/{id}/notes/Em seguida, adicione o caminho à entidade do grupo de seção, seguido pelas funções de link de compartilhamento.
Seu URI de solicitação completo será parecido com estes exemplos:
https://www.onenote.com/api/v1.0/me/notes/sectiongroups/{id}/Microsoft.OneNote.Api.GetOrCreateAnonymousSharingLink
https://www.onenote.com/api/v1.0/users/{id}/notes/sectiongroups/{id}/Microsoft.OneNote.Api.GetOrCreateAnonymousSharingLink
https://www.onenote.com/api/v1.0/myOrganization/siteCollections/{id}/sites/{id}/notes/sectiongroups/{id}/Microsoft.OneNote.Api.GetOrCreateAnonymousSharingLink
https://www.onenote.com/api/v1.0/myOrganization/groups/{id}/notes/sections/{id}/Microsoft.OneNote.Api.GetOrCreateAnonymousSharingLink
Criar um link de compartilhamento anônimo
Para criar um link anônimo para um grupo de seção, envie uma solicitação GET usando o ponto de extremidade apropriado.
GET ../sectiongroups/{sectiongroup-id}/Microsoft.OneNote.Api.GetAnonymousSharingLink
O parâmetro de função accessLevel enum indica o nível de acesso do link de compartilhamento.
| Valores de enumeração do parâmetro accessLevel | Nível de acesso de compartilhamento de link a ser criado (ver ou editar) |
|---|---|
| Exibir | Cria um link somente leitura para o item. |
| Editar | Cria um link de leitura e gravação para o item. |
Exemplo
Solicitação
GET ../api/v1.0/me/notes/sectionGroups/{sectiongroup-id}/Microsoft.OneNote.Api.GetAnonymousSharingLink(accessLevel=Microsoft.OneNote.Api.SharingLinkAccessLevel'View')
Authorization: Bearer {token}
Content-Type: application/json
Accept: application/json
Resposta
HTTP/1.1 200 Ok
{
"@odata.context":"https://www.onenote.com/api/v1.0/$metadata#Edm.String",
"value":"https://www.contoso.com/_layouts/15/WopiFrame.aspx?folderid=084a6fcc95ab54a678257e1b9cba41e7e&authkey=AXXriBu-O475sT4tfJeJDkA&FixProgId=1"
}
Informações de solicitação e resposta
As informações a seguir se aplicam a solicitações /GetAnonymousSharingLink.
| Dados da solicitação | Descrição |
|---|---|
| Protocolo | Todas as solicitações usam o protocolo HTTPS de SSL/TLS. |
| Cabeçalho de autorização | Bearer {token}, onde {token} é um token de acesso do OAuth 2.0 válido para o aplicativo registrado.Se ele estiver ausente ou for inválido, a solicitação falhará com um código de status 401. Confira Autenticar usando o AD do Azure (aplicativos para empresas). |
| Escopo de permissão | Notes.ReadWrite ou Notes.ReadWrite.All |
| Dados da resposta | Descrição |
|---|---|
| Código de êxito | Um código de status de HTTP 200. |
| Corpo da resposta | Uma representação OData do valor no formato JSON. |
| Erros | Se a solicitação falhar, a API retornará erros no corpo da resposta. |
| Cabeçalho X-CorrelationId | Um GUID que identifica de forma exclusiva a solicitação. Você pode usar esse valor com o valor do cabeçalho Date ao trabalhar com o suporte da Microsoft para solucionar problemas. |
Obter ou criar um link de convidado anônimo
Siga estas etapas para obter o link existente ou crie um, caso não exista. O link anônimo pode ser usado para exibir um arquivo do OneNote sem efetuar o login.
POST ../api/v1.0/me/notes/sectionGroups/{sectiongroup-id}/Microsoft.OneNote.Api.GetOrCreateAnonymousSharingLink
No corpo da mensagem, envie um objeto JSON com o parâmetro de atualização.
| Valores de enumeração do parâmetro accessLevel | Nível de acesso de compartilhamento de link a ser criado (ver ou editar) |
|---|---|
| Exibir | Cria um link somente leitura para o item. |
| Editar | Cria um link de leitura e gravação para o item. |
Exemplo
Solicitação
POST ../api/v1.0/me/notes/sectionGroups/{sectiongroup-id}/Microsoft.OneNote.Api.GetOrCreateAnonymousSharingLink
Authorization: Bearer {token}
Content-Type: application/json
Accept: application/json
Resposta
HTTP/1.1 200 Ok
{
"@odata.context":"https://www.onenote.com/api/v1.0/$metadata#Edm.String",
"value":"https://www.contoso.com/_layouts/15/WopiFrame.aspx?folderid=084a6fcc95ab54a678257e1b9cba41e7e&authkey=AXXriBu-O475sT4tfJeJDkA&FixProgId=1"
}
Informações de solicitação e resposta
As informações a seguir se aplicam a solicitações de POST /GetOrCreateAnonymousSharingLink.
| Dados da solicitação | Descrição |
|---|---|
| Protocolo | Todas as solicitações usam o protocolo HTTPS de SSL/TLS. |
| Cabeçalho de autorização | Bearer {token}, onde {token} é um token de acesso do OAuth 2.0 válido para o aplicativo registrado.Se ele estiver ausente ou for inválido, a solicitação falhará com um código de status 401. Confira Autenticar usando o AD do Azure (aplicativos para empresas). |
| Escopo de permissão | Notes.ReadWrite ou Notes.ReadWrite.All |
| Dados da resposta | Descrição |
|---|---|
| Código de êxito | Um código de status de HTTP 200. |
| Corpo da resposta | Uma representação OData do valor no formato JSON. |
| Erros | Se a solicitação falhar, a API retornará erros no corpo da resposta. |
| Cabeçalho X-CorrelationId | Um GUID que identifica de forma exclusiva a solicitação. Você pode usar esse valor com o valor do cabeçalho Date ao trabalhar com o suporte da Microsoft para solucionar problemas. |
Revogar link de convidado anônimo
Siga estas etapas para revogar um link de compartilhamento existente para um grupo de seção.
DELETE ../v1.0/me/notes/sectiongroups/{sectiongroup-id}/Microsoft.OneNote.Api.RevokeAnonymousSharingLink
No corpo da mensagem, envie um objeto JSON com o parâmetro de atualização.
| Valores de enumeração do parâmetro accessLevel | Nível de acesso de compartilhamento de link a ser criado (ver ou editar) |
|---|---|
| Exibir | Cria um link somente leitura para o item. |
| Editar | Cria um link de leitura e gravação para o item. |
Exemplo
Solicitação
DELETE ../v1.0/me/notes/sectiongroups/{sectiongroup-id}/Microsoft.OneNote.Api.RevokeAnonymousSharingLink
Authorization: Bearer {token}
Accept: application/json
{
“accessLevel”: “view”
}
Resposta
HTTP/1.1 204 No Content
Informações de solicitação e resposta
As informações a seguir se aplicam a solicitações DELETE /RevokeAnonymousSharingLink.
| Dados da solicitação | Descrição |
|---|---|
| Protocolo | Todas as solicitações usam o protocolo HTTPS de SSL/TLS. |
| Cabeçalho de autorização | Bearer {token}, onde {token} é um token de acesso do OAuth 2.0 válido para o aplicativo registrado.Se ele estiver ausente ou for inválido, a solicitação falhará com um código de status 401. Confira Autenticar usando o AD do Azure (aplicativos para empresas). |
| Escopo de permissão | Notes.ReadWrite ou Notes.ReadWrite.All |
| Dados da resposta | Descrição |
|---|---|
| Código de êxito | Um código de status de HTTP 200. |
| Erros | Se a solicitação falhar, a API retornará erros no corpo da resposta. |
| Cabeçalho X-CorrelationId | Um GUID que identifica de forma exclusiva a solicitação. Você pode usar esse valor com o valor do cabeçalho Date ao trabalhar com o suporte da Microsoft para solucionar problemas. |
Ativar ou desativar o compartilhamento externo para um ambiente do SharePoint Online
Gerenciar compartilhamento externo para o ambiente do SharePoint Online
Construir a URL raiz de serviço do OneNote
A URL raiz do serviço do OneNote usa o formato a seguir para todas as chamadas para o OneNote.
https://www.onenote.com/api/{version}/{location}/notes/
O segmento version na URL representa a versão da API do OneNote que você deseja usar.
- Use
v1.0para o código de produção estável. - Use
betapara experimentar um recurso que está em desenvolvimento. Os recursos e a funcionalidade na versão beta podem mudar, por isso, você não deve usá-la no código de produção.
O segmento location na URL representa a localização dos blocos de anotações que você deseja acessar.
Blocos de anotações no OneDrive for Business
Use me para conteúdos do OneNote pertencentes ao usuário atual.
Use users/{id} para o conteúdo do OneNote que o usuário especificado (na URL) compartilhou com o usuário atual. Use a API gráfica do AD do Azure para obter as IDs de usuários.
Blocos de anotações do site do SharePoint
Sites de equipe e outros sites do SharePoint podem conter blocos de anotações do OneNote em suas bibliotecas de documentos.
Use myOrganization/siteCollections/{id}/sites/{id} para conteúdos do OneNote em um site no locatário em que o usuário atual está conectado. Apenas o locatário atual tem suporte, acessado com a palavra-chave myOrganization.
Blocos de anotações de grupo do Office 365
Os grupos do Office 365 fazem parte da experiência conectada do Office 365. Os membros do grupo podem compartilhar blocos de anotações, arquivos e e-mails.
Use myOrganization/groups/{id} para conteúdos do OneNote no grupo especificado do qual o usuário atual é membro. Os grupos do Office 365 (que retornam o groupType unificado) são o único tipo de grupo com suporte. Use a API gráfica do AD do Azure para obter as IDs de grupos.
Use o método FromUrl para obter o conjunto de sites e as IDs dos sites
Você pode usar o método FromUrl para obter o conjunto de sites e as IDs dos sites para uma URL absoluta do site especificado. Você deve fazer essa chamada somente quando necessário e armazenar os valores para uso futuro.
O formato da URL do site depende da sua configuração, por exemplo https://domain.sharepoint.com/site-a ou https://domain.com/sites/site-a.
Exemplo de solicitação
GET https://www.onenote.com/api/v1.0/myOrganization/siteCollections/FromUrl(url='{full-path-to-SharePoint-site}')
Authorization: Bearer {token}
Accept: application/json
Resposta de exemplo
{
"@odata.context":"https://www.onenote.com/api/v1.0/$metadata#Microsoft.OneNote.Api.SiteMetadata",
"siteCollectionId":"09d1a587-a84b-4264-3d15-669429be8cc5",
"siteId":"d9e4d5c8-683f-4363-89ae-18c4e3da91e9"
}
Requisitos para uso de FromUrl e como trabalhar com os blocos de anotações do site do SharePoint:
Você só pode criar blocos de anotações, grupos de seções, seções e páginas do OneNote em sites que tenham uma biblioteca de documentos padrão. (Alguns modelos de site não criam uma biblioteca de documentos padrão.) No entanto, as solicitações GET retornam o conteúdo do OneNote de todas as bibliotecas de documentos no site.
A URL da raiz do serviço do OneNote é imutável, o que significa que você não pode usar um caminho do site da API REST do SharePoint e depois rastrear o ponto de extremidade
notesnele.O usuário para quem você está fazendo a chamada deve ser membro do site.
O método FromUrl funciona apenas com sites que foram indexados. Pode levar várias horas para indexar um site novo.