Ir para o conteúdo

Microsoft 365 - Sharepoint

Interaja e execute várias operações por meio de uma conta do Microsoft 365. Baixe, carregue e gerencie arquivos e itens facilmente através do plugin BotCity para o OneDrive/Sharepoint.

Importante

O suporte para o serviço do Sharepoint está incluído no plugin do OneDrive. Portanto, o mesmo pacote é utilizado.

As operações com os itens são feitas da mesma maneira, a única diferença é a forma que o drive será acessado.

Veja mais detalhes acessando a documentação do plugin do OneDrive.

Aviso

Para poder usar este plugin, você precisa ter uma conta do Microsoft 365 com um projeto criado e configurado corretamente.

Depois de criar um projeto, você precisa concluir o processo de autenticação por meio do plugin Microsoft 365 Credentials.

Para mais detalhes, consulte as seções anteriores:

Instalação

pip install botcity-ms365-onedrive-plugin

Importando o Plugin

Depois de instalar este pacote, a próxima etapa é importar o pacote no seu código e começar a usar as funções.

from botcity.plugins.ms365.onedrive import MS365OneDrivePlugin

Configurando a conta de serviço

Conforme mencionado acima, para usar o plugin do OneDrive/Sharepoint, é necessário realizar o processo de autenticação da conta por meio do plugin Microsoft 365 Credentials.

Com a instância do plugin de credenciais obtida, vamos usá-la para instanciar o plugin.

from botcity.plugins.ms365.credentials import MS365CredentialsPlugin, Scopes
from botcity.plugins.ms365.onedrive import MS365OneDrivePlugin

# Instanciando o plugin de Credenciais
service = MS365CredentialsPlugin(
    client_id='<APPLICATION ID>',
    client_secret='<SECRET VALUE>',
)
service.authenticate(scopes=[Scopes.BASIC, Scopes.FILES_READ_WRITE_ALL, Scopes.SITES_READ_WRITE_ALL])

Dica

Para utilizar o serviço do Sharepoint, além de adicionar o escopo Scopes.FILES_READ_WRITE_ALL referente à permissão Files.ReadWrite.All, também é necessário incluir o escopo Scopes.SITES_READ_WRITE_ALL referente à permissão Sites.ReadWrite.All do projeto.

Veja mais detalhes sobre escopos e permissões nesse link.

Obtendo a referência de um site do Sharepoint

O primeiro passo para conseguirmos acessar uma biblioteca de documentos do Sharepoint, é configurarmos o site que será utilizado como referência.

Ao instanciar o plugin, podemos passar como parâmetro algumas informações específicas do site que estamos tentando acessar.

Após isso, já conseguimos acessar a biblioteca de documentos (drive) padrão do site.

Dica

Ao informar o caminho para o site, deve ser incluído sites/ no início do caminho, seguido do nome exato do site.

Na maioria dos casos, esse caminho deve ser informado no seguinte formato: sites/{nome_site}.

from botcity.plugins.ms365.credentials import MS365CredentialsPlugin, Scopes
from botcity.plugins.ms365.onedrive import MS365OneDrivePlugin

# Instanciando o plugin de Credenciais
service = MS365CredentialsPlugin(
    client_id='<APPLICATION ID>',
    client_secret='<SECRET VALUE>',
)
service.authenticate(scopes=[Scopes.BASIC, Scopes.FILES_READ_WRITE_ALL, Scopes.SITES_READ_WRITE_ALL])

# Instanciando o plugin com as informações do Sharepoint
sharepoint = MS365OneDrivePlugin(
    service_account=service,
    use_sharepoint=True,
    host_name="yourcompany.sharepoint.com",
    path_to_site="sites/Site-To-Access"
)

Caso seja necessário realizar as operações utilizando o drive de um outro site específico, você pode configurar facilmente a referência para o novo site.

sharepoint.set_sharepoint_site(
    host_name="yourcompany.sharepoint.com",
    path_to_site="sites/TestSite2"
)

Gerenciando arquivos

Com o serviço do Sharepoint configurado corretamente, é possível realizarmos operações com os arquivos e pastas.

Essas operações se baseiam nas funcionalidades do OneDrive. Portanto, os mesmos métodos do plugin podem ser utilizados.

Veja mais detalhes sobre as operações com arquivos e pastas acessando a documentação do plugin do OneDrive.