SharePoint API y API REST: ¿qué son y para qué sirven?

SharePoint API: ¿qué son y para qué sirven?

Las API son el medio a través del cual un programa puede comunicarse con otro programa o con una fuente de datos externa.

En el caso de SharePoint Online, las API permiten enriquecer un sitio, como la intranet empresarial, mediante el desarrollo de componentes personalizados y dinámicos.

Los desarrolladores utilizan las API para conectar SharePoint con fuentes de datos específicas, de las cuales obtienen información útil para crear funcionalidades y contenidos integrados directamente en los elementos web de un sitio.

Por ejemplo, una web part puede conectarse a una base de datos externa para mostrar la lista de proyectos archivados, permitiendo a los usuarios autorizados acceder rápidamente a la información de su interés.

Cuando la información en una fuente de datos conectada a SharePoint a través de API se actualiza, los contenidos de los elementos web pueden sincronizarse.

Sin embargo, la actualización en tiempo real depende de la configuración: a menudo es necesario un refresco manual de la página o la implementación de soluciones personalizadas, como scripts específicos o funcionalidades de auto-actualización.

Las API de SharePoint se dividen en cuatro categorías principales. Veámoslas en la siguiente tabla.

 

SharePoint API: principales tipos

 

Tipos de SharePoint API	Descripción
REST API	Permiten el acceso y la manipulación de los recursos de SharePoint mediante simples llamadas HTTP. Las solicitudes RESTful permiten realizar operaciones CRUD (Create, Read, Update, Delete) sobre elementos como listas, documentos y sitios, lo que las convierte en una herramienta clave para muchas integraciones.
Client-Side Object Model	Un conjunto de bibliotecas que se pueden utilizar en lenguajes como JavaScript, .NET y Silverlight. Las API CSOM son útiles para realizar operaciones del lado del cliente, ejecutando código directamente en el navegador del usuario o en aplicaciones de escritorio.
JavaScript Object Model	Una variante de CSOM específica para JavaScript, utilizada principalmente para crear interfaces dinámicas en los elementos web de SharePoint. Se adopta ampliamente para la personalización de sitios empresariales.
SOAP Web Services	Aunque se usan menos que otras, estas API permiten la comunicación con SharePoint a través de protocolos basados en XML. Aunque tienen un papel secundario, siguen siendo útiles en escenarios heredados o para realizar integraciones particulares.

 

Gracias a las API, como mencionamos, es posible conectar SharePoint con una amplia gama de fuentes de datos y servicios externos, incluidos bases de datos (como SQL Server), servicios en la nube (como Microsoft Azure) y sistemas ERP/CRM (como Dynamics 365 y Salesforce).

Estas integraciones permiten centralizar la información dentro de la intranet empresarial o de cualquier sitio basado en SharePoint Online, eliminando la necesidad de que los usuarios accedan a sistemas separados para obtener la información de su interés o de transferir manualmente los datos después de cada actualización.

Las API representan, por lo tanto, los bloques fundamentales para construir, personalizar y mantener todos los elementos web que enriquecen las funcionalidades y los contenidos de un sitio de SharePoint, ofreciendo un ecosistema potente y flexible para satisfacer cualquier necesidad.

 

SharePoint REST API: ¿qué son y para qué sirven?

Las REST API ("Representational State Transfer Application Programming Interfaces) son un conjunto de principios arquitectónicos para diseñar y desarrollar sistemas de red.

La arquitectura REST se centra en el concepto de recursos. Se basan en un modelo de comunicación donde los clientes envían solicitudes a los servidores para realizar acciones sobre recursos específicos.

Estas solicitudes típicamente se manifiestan en forma de métodos HTTP como GET, POST, PUT, PATCH y DELETE, cada uno de los cuales corresponde a diferentes operaciones sobre los recursos.

En el caso específico de SharePoint, los recursos sobre los que actúan las REST API pueden ser:

• Los elementos de una lista
• Los documentos de una biblioteca
• Un sitio, en su totalidad

Los clientes pueden entonces enviar solicitudes HTTP para realizar acciones sobre los recursos, como recuperar información específica o realizar cambios. Un ejemplo sería enviar la solicitud GET para obtener los detalles de un documento en una biblioteca de SharePoint; un segundo ejemplo podría ser la solicitud POST, utilizada frecuentemente para agregar nuevos elementos a una lista.

Esta flexibilidad hace que las REST API sean una herramienta poderosa para integrar y automatizar las interacciones con SharePoint, permitiendo a los desarrolladores construir aplicaciones que se conecten fácilmente con los datos y funcionalidades de la plataforma.

Otros aspectos que caracterizan las REST API de SharePoint incluyen:

• Facilidad de uso, permitiendo trabajar con datos estructurados y no estructurados de manera eficiente.
  
  
• Seguridad, ya que la autenticación se gestiona a través de OAuth y tokens de acceso. Esto significa que solo los usuarios y aplicaciones autorizados pueden interactuar con los recursos.
  
  
• Independencia del contexto, ya que las solicitudes REST pueden realizarse desde cualquier entorno que soporte llamadas HTTP, incluidos los navegadores y aplicaciones móviles.
  
  
• Escalabilidad, permitiendo manejar un alto número de solicitudes simultáneas sin sobrecargar el servidor.
  
  

Pero, ¿cómo se pueden usar en la práctica las REST API de SharePoint en la empresa?

Como mencionábamos, las REST API son una herramienta clave en el ecosistema de SharePoint Online para automatizar procesos, integrar sistemas y crear soluciones personalizadas para enriquecer sitios como la intranet y la extranet. Por ejemplo, un primer caso de uso podría ser la gestión documental.

Un contrato firmado, por ejemplo, puede cargarse en una biblioteca de SharePoint con metadatos predefinidos, facilitando su acceso para el equipo legal. Del mismo modo, los datos almacenados pueden usarse para crear paneles interactivos, integrándolos con herramientas como Power BI para monitorear los KPI o el avance de un proyecto.

Además, es posible crear sistemas de notificaciones o aprobaciones para simplificar la gestión de tareas diarias. En este caso, un ejemplo podría ser el uso de las REST API para enviar automáticamente un correo electrónico al responsable cuando un elemento insertado en una lista de SharePoint requiera su validación.

Las REST API también se aplican en la creación de portales dedicados a los empleados, como aquellos creados para acceder a documentos personales o para enviar tickets de soporte. Además, pueden integrarse con sistemas de terceros, como CRM o herramientas de gestión de recursos humanos, para centralizar la información sobre el personal, proveedores y clientes.

 

 

¿Cuál es la diferencia entre API y REST API en SharePoint?

Como hemos visto, las API son conjuntos de definiciones y protocolos que permiten a diferentes software comunicarse entre sí. Existen varios tipos, incluyendo API de bibliotecas, API de sistema operativo o API de servicio web, que pueden ser diseñadas utilizando diversos estilos arquitectónicos y protocolos como SOAP, GraphQL y REST.

Las REST API, específicamente, representan un tipo de API que sigue los principios arquitectónicos del REST (Representational State Transfer).

Este estilo se caracteriza por un modelo de comunicación sin estado, donde cada solicitud del cliente al servidor contiene toda la información necesaria para realizar la operación solicitada. Las REST API utilizan los métodos HTTP (GET, POST, PUT, PATCH, DELETE) para realizar operaciones sobre los recursos, identificados por URL únicas.

Entonces: mientras todas las REST API son API, no todas las API son REST API.

También en el caso de SharePoint, las REST API son solo una de las muchas formas a través de las cuales se puede interactuar con plataformas y fuentes de datos externas.

En particular, es útil utilizar las REST API para crear los elementos web de un sitio SharePoint cuando se necesita una comunicación ligera y flexible con las fuentes de datos conectadas.

Las REST API permiten construir elementos web dinámicos e interactivos, capaces de interactuar con una variedad de fuentes de datos internas y externas sin comprometer el rendimiento o la simplicidad del código.

Otros tipos de API pueden ser útiles en diferentes situaciones.

Por ejemplo, las SOAP API son más adecuadas en casos de integraciones complejas que requieren un mayor control sobre la comunicación. De la misma manera, las API de tipo CSOM son preferidas por los desarrolladores que trabajan con un modelo de objetos del lado del cliente, ofreciendo una experiencia de desarrollo más natural en las aplicaciones.

¿A qué fuentes de datos se puede conectar SharePoint a través de la API?

Gracias a las API, SharePoint Online puede conectarse a una amplia gama de fuentes de datos y programas para enriquecer las funcionalidades y contenidos de sitios como la intranet corporativa. En el caso de la intranet, los elementos web pueden aprovechar las API de SharePoint para conectarse a las siguientes fuentes de datos.

 

 

1. Listas y bibliotecas de SharePoint

Los elementos web pueden interactuar con las listas y bibliotecas de SharePoint a través de la API para gestionar datos estructurados como anuncios, contactos, eventos y actividades. Esto permite una visualización intuitiva y la modificación directa de los contenidos, incluidos documentos corporativos y archivos multimedia, sin necesidad de salir del sitio de SharePoint en el que se encuentra el elemento web.

 

Elemento web para promover las noticias empresariales en la intranet de SharePoint de intranet.ai

2. Bases de datos externas

Aunque las API REST de SharePoint no admiten una conexión directa con bases de datos externas, en el pasado era posible utilizar los Servicios de Conectividad Empresarial (Business Connectivity Services, o BCS) para conectarse a bases de datos relacionales u orígenes OData. Sin embargo, Microsoft ha descontinuado definitivamente los BCS a partir del 30 de septiembre de 2024.

Hoy en día, se recomienda utilizar herramientas como Power Apps y Power Automate para integrar dicha información en SharePoint, ya que ofrecen conectores dedicados para vincular bases de datos relacionales de manera segura y flexible. Estas herramientas también permiten crear interfaces intuitivas para gestionar los datos directamente dentro de la intranet, sin necesidad de soluciones intermedias.

 

Integrar datos en SharePoint mediante Power Apps

3. Aplicaciones de Microsoft 365

A través de API, es posible integrar en los elementos web de SharePoint la información proveniente de otros productos que componen el lugar de trabajo digital de Microsoft 365. Entre estos, encontramos:

• Outlook, para integrar correos electrónicos, calendarios y contactos;
• OneDrive, para simplificar la gestión de archivos personales y compartidos.
• Teams, para integrar chats, canales y otras funciones de colaboración.
• Planner, para actualizar las tareas del proyecto y coordinar el trabajo del equipo.

 

Elemento web de Microsoft Planner para SharePoint

4. Servicios en la nube

Los elementos web de SharePoint pueden comunicarse con los servicios de Microsoft Azure, incluidos Azure Blob Storage, Azure Functions y Azure SQL Database. Además, pueden mostrar los informes y los paneles de Power BI.

 

Integración de un informe de Power BI en SharePoint Online

5. ERP/CRM

Los elementos web de SharePoint pueden obtener los datos presentes en sistemas como Microsoft Dynamics 365 y Salesforce. La información relacionada con los clientes, ventas y actividades de soporte se vuelve accesible en la intranet, apoyando el trabajo de los usuarios.

Por ejemplo, el equipo de Ventas podría ver las comunicaciones recientes con los clientes gestionadas por el equipo de soporte y obtener ideas útiles para gestionar las negociaciones comerciales. De manera similar, el equipo de soporte podría acceder a los detalles de las ventas para analizar los problemas de los clientes y proponer soluciones para resolverlos.

 

Integración de datos en Microsoft Dynamics 365 en SharePoint

6. Redes sociales y otros canales de comunicación

Los elementos web se pueden integrar con los perfiles sociales empresariales, por ejemplo, los de LinkedIn o Twitter, para mostrar en la intranet las últimas publicaciones o resaltar los contenidos más importantes para la organización.

 

Elemento web "Publicaciones en redes sociales" de intranet.ai

Además de las redes sociales, también se pueden importar en SharePoint Online contenidos en formato RSS, como las noticias provenientes de una revista del sector en línea.

 

Elemento web "RSS Feed" de intranet.ai

SharePoint API y Microsoft Graph API: ¿existe alguna relación?

Microsoft Graph es una plataforma de desarrollo que ofrece una puerta de enlace unificada para acceder a los datos y servicios de Microsoft 365, incluidos Azure Active Directory, Outlook, OneDrive, Teams, Excel, Planner y SharePoint.

Permite acceder a los múltiples servicios de Microsoft desde un único punto de entrada, simplificando enormemente el desarrollo y la gestión de aplicaciones por parte de los desarrolladores.

Graph también admite una amplia gama de operaciones, entre las que se incluyen:

• interacción con los archivos y documentos en OneDrive
• gestión del correo y el calendario en Outlook
• colaboración y comunicación en Microsoft Teams
• gestión de identidades de usuario en Azure Active Directory

Por lo tanto, existe una relación estrecha entre las API de los productos de Microsoft 365 y las API de Microsoft Graph, y SharePoint no es una excepción.

La integración de las API de SharePoint en el ecosistema de Microsoft Graph permite a los desarrolladores acceder a los datos y funcionalidades de SharePoint a través de los mismos puntos finales y tokens de autenticación utilizados para otros servicios de Microsoft 365.

En la práctica, las API de Microsoft Graph proporcionan una interfaz uniforme para interactuar con los recursos de SharePoint, facilitando la interoperabilidad entre el propio SharePoint y otros servicios de Microsoft 365.

Con Microsoft Graph, por ejemplo, es posible recuperar información sobre un sitio de SharePoint, acceder a documentos almacenados en una biblioteca o gestionar los permisos de acceso a los archivos empresariales. De manera sencilla, a través de llamadas HTTP.

El resultado es una plataforma robusta e integrada que simplifica el proceso de desarrollo, permitiendo a las empresas aprovechar al máximo el potencial de sus datos y aplicaciones.

FAQ sobre las API de SharePoint y las API REST

¿Qué son las API de SharePoint y para qué sirven?

Las API de SharePoint son conjuntos de definiciones y protocolos que permiten la comunicación entre SharePoint y otras aplicaciones o fuentes de datos externas. Estas API permiten crear, personalizar y mantener los elementos web que componen sitios como la intranet empresarial, garantizando la integración y la actualización automática de los contenidos.

¿Qué son las API REST de SharePoint y para qué sirven?

Las API REST de SharePoint son un conjunto de principios arquitectónicos para diseñar y desarrollar sistemas de red. Permiten el acceso y la manipulación de los recursos de SharePoint mediante sencillas llamadas HTTP, realizando operaciones CRUD (Create, Read, Update, Delete) sobre elementos como listas, documentos y sitios.

¿Cuál es la diferencia entre API y API REST en SharePoint?

Las API son conjuntos de definiciones y protocolos para la comunicación entre software diverso, mientras que las API REST representan un tipo de API que sigue los principios arquitectónicos de REST (Representational State Transfer). Las API REST utilizan métodos HTTP para realizar operaciones sobre los recursos, identificados por URL únicas. No todas las API son API REST, pero todas las API REST son API.

¿A qué fuentes de datos se puede conectar SharePoint mediante API?

SharePoint puede conectarse a una amplia gama de fuentes de datos mediante API, incluyendo listas y bibliotecas de SharePoint, bases de datos externas (como SQL Server y Oracle), aplicaciones de Microsoft 365 (Outlook, OneDrive, Teams, Planner), servicios en la nube (Microsoft Azure, Power BI), ERP/CRM (Dynamics 365, Salesforce), herramientas de Business Intelligence (Tableau, Qlik) y canales de comunicación como redes sociales y feeds RSS.

¿Existe una relación entre las API de SharePoint y la API de Microsoft Graph?

Sí, Microsoft Graph es una plataforma que ofrece una puerta de enlace unificada para el acceso a los datos y servicios de Microsoft 365, incluidos SharePoint. La integración de las API de SharePoint en Microsoft Graph permite a los desarrolladores acceder a las funcionalidades de SharePoint a través de los mismos puntos finales y tokens de autenticación utilizados para otros servicios de Microsoft 365, simplificando la interoperabilidad entre SharePoint y otros servicios de Microsoft.