Saltar a contenido

Microsoft 365 - Sharepoint

Interactúa y realiza diversas operaciones a través de una cuenta de Microsoft 365. Descarga, carga y administra archivos y elementos fácilmente a través del complemento de BotCity para OneDrive/Sharepoint.

Important

El soporte para el servicio de Sharepoint está incluido en el complemento de OneDrive. Por lo tanto, se utiliza el mismo paquete.

Las operaciones con los elementos se realizan de la misma manera; la única diferencia es cómo se accederá a la unidad.

Consulta más detalles en la documentación del complemento de OneDrive.

Warning

Para poder utilizar este complemento, necesitas tener una cuenta de Microsoft 365 con un proyecto creado y configurado correctamente.

Después de crear un proyecto, debes completar el proceso de autenticación a través del complemento de Credenciales de Microsoft 365.

Para más detalles, consulta las secciones anteriores:

Instalación

pip install botcity-ms365-onedrive-plugin

Importación del Complemento

Después de instalar este paquete, el siguiente paso es importar el paquete en tu código y comenzar a utilizar las funciones.

from botcity.plugins.ms365.onedrive import MS365OneDrivePlugin

Configuración de la cuenta de servicio

Como se mencionó anteriormente, para utilizar el complemento de OneDrive/Sharepoint, es necesario realizar el proceso de autenticación de la cuenta a través del complemento de Credenciales de Microsoft 365.

Con la instancia del complemento de credenciales obtenida, vamos a utilizarla para instanciar el complemento.

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

# Instantiate the Credentials plugin
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])

Tip

Para utilizar el servicio de Sharepoint, además de agregar el ámbito Scopes.FILES_READ_WRITE_ALL que se refiere al permiso Files.ReadWrite.All, también es necesario incluir el ámbito Scopes.SITES_READ_WRITE_ALL que se refiere al permiso Sites.ReadWrite.All del proyecto.

Consulta más detalles sobre ámbitos y permisos en este enlace.

Obtención de una referencia al sitio de Sharepoint

El primer paso para acceder a una biblioteca de documentos de Sharepoint es configurar el sitio que se utilizará como referencia.

Al instanciar el complemento, podemos pasar como parámetro alguna información específica sobre el sitio al que estamos intentando acceder.

Después de eso, podemos acceder a la biblioteca de documentos (unidad) predeterminada del sitio.

Tip

Al ingresar la ruta del sitio, incluye sites/ al principio de la ruta, seguido del nombre exacto del sitio.

En la mayoría de los casos, esta ruta debe pasarse en el siguiente formato: sites/{nombre_del_sitio}.

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

# Instantiate the Credentials plugin
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])

# Instantiating the plugin with Sharepoint information
sharepoint = MS365OneDrivePlugin(
    service_account=service,
    use_sharepoint=True,
    host_name="yourcompany.sharepoint.com",
    path_to_site="sites/Site-To-Access"
)

Si es necesario realizar las operaciones utilizando la unidad de otro sitio específico, puedes configurar fácilmente la referencia al nuevo sitio.

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

Administración de archivos

Con el servicio de Sharepoint configurado correctamente, es posible realizar operaciones con archivos y carpetas.

Estas operaciones se basan en las funcionalidades de OneDrive. Por lo tanto, se pueden utilizar los mismos métodos del complemento.

Consulta más detalles sobre las operaciones con archivos y carpetas accediendo a la documentación del complemento de OneDrive.