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

Las API son el medio por el que diferentes sistemas se comunican entre sí, intercambiando datos y comandos. SharePoint, la principal plataforma de colaboración de Microsoft 365, explota diferentes tipos de API para permitir a los usuarios crear, personalizar y mantener las partes web que componen sitios como la intranet corporativa. Entre estas API, las REST API juegan un papel importante debido a su flexibilidad.

En este artículo veremos en detalle qué son y para qué sirven las API de SharePoint, qué distingue a las REST API y qué funcionalidades son posibles gracias a la integración con Microsoft Graph.

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

En programación, las API son los medios que permiten a un programa comunicarse con otro programa o con una fuente de datos externa. En el caso de SharePoint, las API permiten crear las partes web de un sitio como la intranet.

Los desarrolladores utilizan entonces las API para conectar SharePoint a fuentes de datos específicas, de las que obtienen la información necesaria para ofrecer contenidos y funcionalidades en las partes web que componen un sitio.

Cuando se actualiza la información de una fuente de datos conectada a SharePoint a través de una API, es importante tener en cuenta que el contenido de la parte web correspondiente se actualiza automáticamente y en tiempo real.

Las API de SharePoint se dividen en cuatro categorías principales:

1. REST API, que permiten acceder y manipular los recursos de SharePoint con simples llamadas HTTP. En general, las solicitudes RESTful realizan operaciones CRUD (Crear, Leer, Actualizar, Eliminar) en elementos de SharePoint como listas, documentos y sitios.
   
   
2. Client-Side Object Model (CSOM): El tipo de API que proporciona un conjunto de bibliotecas para ser utilizadas en lenguajes como JavaScript, .NET y Silverlight para interactuar con SharePoint. Estas API son útiles para realizar operaciones del lado del cliente, ya que implican la ejecución de código directamente en el navegador del usuario.
   
   
3. JavaScript Object Model (JOM): una categoría de API similar a CSOM, pero específica de JavaScript. Por ello, suele utilizarse para crear las interfaces dinámicas de las partes web de SharePoint.
   
   
4. SOAP Web Services: aunque menos utilizadas que las anteriores, estas API permiten comunicarse con SharePoint mediante protocolos basados en XML.
   
   

El conjunto de API de SharePoint permite conectar web parts a una amplia gama de fuentes de datos, incluyendo bases de datos externas (por ejemplo, SQL Server), servicios en la nube (por ejemplo, Microsoft Azure), sistemas ERP/CRM (por ejemplo, Dynamics 365 y Salesforce), y un sinfín de otros servicios y aplicaciones.

Tomando como ejemplo una conexión API con un servidor SQL Server, una parte web podría mostrar la lista de proyectos almacenados en la base de datos. Esta integración permite a los usuarios autorizados ver la información de su interés directamente en la intranet de SharePoint, sin tener que acceder a sistemas separados o transferir manualmente los datos tras una actualización.

Esto es, pues, lo que son las API de SharePoint: los bloques de construcción que necesitamos para construir, personalizar y mantener todas las partes web que enriquecen la funcionalidad y el contenido de cualquier sitio de SharePoint.

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

Las REST API, siglas de 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 basa en un modelo de comunicación en el que los clientes envían peticiones a los servidores para realizar acciones en recursos específicos. Estas peticiones suelen adoptar la forma de métodos HTTP como GET, POST, PUT, PATCH y DELETE, cada uno de los cuales corresponde a distintas operaciones sobre los recursos.

En el caso concreto de SharePoint, los recursos sobre los que actúa la API REST pueden ser:

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

A continuación, los clientes pueden enviar peticiones HTTP para realizar acciones sobre los recursos, como recuperar determinada información o realizar cambios. Un ejemplo sería enviar una solicitud GET para obtener los detalles de un documento en una biblioteca de SharePoint; un segundo ejemplo podría ser una solicitud POST, a menudo utilizada para añadir elementos a una lista.

Esta flexibilidad convierte a la API REST en una potente herramienta para integrar y automatizar las interacciones con SharePoint, permitiendo a los desarrolladores crear aplicaciones que interactúen fácilmente con los datos y la funcionalidad de la plataforma.

Otros aspectos que caracterizan a la REST API de SharePoint son:

1. Facilidad de uso, ya que permite trabajar con datos estructurados y no estructurados de forma eficiente.
2. Seguridad, ya que la autenticación se gestiona mediante OAuth y tokens de acceso. Esto significa que sólo los usuarios y aplicaciones autorizados pueden interactuar con los recursos.
3. Independencia del contexto, ya que las solicitudes REST pueden realizarse desde cualquier entorno que admita llamadas HTTP, incluidos navegadores y aplicaciones móviles.
4. Escalabilidad, ya que permite gestionar un gran número de peticiones simultáneas sin sobrecargar el servidor.

¿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 que distintos programas informáticos se comuniquen entre sí. Existen varios tipos, como las API de bibliotecas, las API de sistemas operativos o las API de servicios web, que pueden diseñarse utilizando varios estilos arquitectónicos y protocolos como SOAP, GraphQL y REST.

Las REST API, en concreto, representan un tipo de API que sigue los principios arquitectónicos de REST (Representational State Transfer). Este estilo se caracteriza por un modelo de comunicación sin estado, en el que cada petición del cliente al servidor contiene toda la información necesaria para realizar la operación solicitada. Las API REST utilizan métodos HTTP (GET, POST, PUT, PATCH, DELETE) para realizar operaciones sobre recursos, identificados por URL únicas.

Así pues: aunque todas las REST API son API, no todas las API son REST API.

Incluso en el caso de SharePoint, las API REST son sólo una de las muchas formas en que es posible interactuar con plataformas y fuentes de datos externas. Resulta útil utilizar las API REST para crear partes web de SharePoint cuando se requiere una comunicación ligera y flexible con fuentes de datos conectadas.

De hecho, las API REST permiten crear partes web dinámicas e interactivas capaces de interactuar con diversas fuentes de datos internas y externas sin comprometer el rendimiento o la simplicidad del código.

Otros tipos de API pueden servir en contextos diferentes. Por ejemplo, las API de tipo SOAP son más adecuadas en el caso de integraciones complejas que requieren un mayor control sobre la comunicación. Del mismo modo, las API de tipo CSOM son las preferidas por los desarrolladores que trabajan con un modelo de objetos del lado del cliente, ya que ofrecen una experiencia de desarrollo más natural en las aplicaciones.

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

Gracias a su API, SharePoint puede conectarse a una amplia gama de fuentes de datos y programas para enriquecer la funcionalidad y el contenido de sitios como la intranet.

Sólo en el caso de la intranet, las partes web pueden aprovechar la API de SharePoint para conectarse a las siguientes fuentes de datos.

1. Listas y bibliotecas de SharePoint

Las partes web pueden gestionar datos estructurados como anuncios, contactos, eventos y actividades. También facilitan la visualización y edición de contenidos en repositorios de SharePoint, como documentos empresariales o archivos multimedia.

2. Bases de datos externas

Las partes web se conectan a bases de datos de SQL Server, lo que permite a los usuarios de la intranet acceder directamente a la información archivada sin cambiar de entorno. Además, las API también permiten que las partes web se conecten a sistemas de gestión de bases de datos, como Oracle, para ofrecer una visión centralizada de los datos corporativos.

3. Aplicaciones de Microsoft 365

La información de los otros productos que componen el lugar de trabajo digital Microsoft 365 (del que SharePoint forma parte) se puede integrar en las partes web de SharePoint a través de API. Estos productos incluyen:

• Outlook, para integrar correo electrónico, calendario y contactos.
• OneDrive, para simplificar la gestión de archivos personales y compartidos.
• Teams, para integrar chat, canales y otras funciones de colaboración.
• Planner, para actualizar las actividades de los proyectos y coordinar el trabajo en equipo.

4. Servicios en la nube

Las partes web de SharePoint pueden comunicarse con los servicios de Microsoft Azure, incluidos Azure Blob Storage, Azure Functions y Azure SQL Database. Además, pueden informar sobre informes y cuadros de mando de Power BI.

5. ERP/CRM

Las partes web pueden obtener datos de sistemas como Microsoft Dynamics 365 y Salesforce. La información sobre clientes, ventas y actividades de soporte pasa así a estar disponible 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 información útil para gestionar las negociaciones de venta. Del mismo modo, el equipo de asistencia puede acceder a los datos de ventas para analizar los problemas de los clientes y proponer soluciones personalizadas.

6. Herramientas de Business Intelligence

Además de Power BI, las partes web de SharePoint pueden conectarse mediante API a Tableau y Qlik. Estas son algunas de las herramientas más populares y utilizadas en las empresas para el análisis de datos, y la integración con SharePoint permite centralizar el acceso a la información en la intranet y optimizar así los procesos de toma de decisiones.

7. Redes sociales y otros canales de comunicación

Las partes web pueden integrarse con los perfiles sociales de la empresa, por ejemplo los de LinkedIn o Twitter, para mostrar los últimos posts publicados en la intranet o destacar los contenidos más importantes para la empresa. Además de las redes sociales, también se pueden importar a SharePoint contenidos en formato RSS (por ejemplo, noticias de una revista comercial en línea).

En intranet.ai, nos hemos basado en este uso de la API de SharePoint para crear las partes web "Publicaciones en redes sociales" y "RSS Feed", con las que nuestros clientes pueden enriquecer fácilmente el contenido de la intranet que hemos construido juntos.

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

Microsoft Graph es una plataforma para desarrolladores que proporciona 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.

De este modo, permite acceder a los múltiples servicios de Microsoft desde un único punto de entrada, lo que simplifica enormemente el desarrollo y la gestión de aplicaciones para los desarrolladores. Graph también admite una amplia gama de operaciones, entre las que se incluyen:

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

Existe, por tanto, una estrecha relación entre las APIs de los productos Microsoft 365 y las APIs de Microsoft Graph, y SharePoint no es una excepción.

La integración de las APIs 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 endpoints 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 SharePoint y otros servicios de Microsoft 365.

Con Microsoft Graph es posible, por ejemplo, recuperar información de un sitio de SharePoint, acceder a documentos almacenados en una biblioteca o gestionar los permisos de acceso a los archivos de la empresa. De forma 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 explotar al máximo el potencial de sus datos y aplicaciones.

¿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 las web parts que componen sitios como la intranet empresarial, garantizando la integración y actualización automática de los contenidos.

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

Las REST API 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 simples llamadas HTTP, ejecutando operaciones CRUD (Crear, Leer, Actualizar, Eliminar) sobre elementos como listas, documentos y sitios.

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

Las API son conjuntos de definiciones y protocolos para la comunicación entre diferentes software, mientras que las REST API representan un tipo de API que sigue los principios arquitectónicos de REST (Representational State Transfer). Las REST API utilizan métodos HTTP para ejecutar operaciones sobre los recursos, identificados por URLs únicas. No todas las API son REST API, pero todas las REST API 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 RSS feeds.

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

Sí, Microsoft Graph es una plataforma que ofrece una puerta de enlace unificada para el acceso a 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 mediante los mismos endpoints y tokens de autenticación utilizados para otros servicios de Microsoft 365, simplificando la interoperabilidad entre SharePoint y otros servicios de Microsoft.