SharePoint API et REST API : à quoi servent-elles ?

SharePoint API : que sont-elles ?

Les API sont les moyens par lesquels un programme peut communiquer avec un autre programme ou une source de données externe. Dans le cas de SharePoint Online, les API permettent d'enrichir un site, tel que l'intranet d'entreprise, par le développement de composants personnalisés.

Les développeurs utilisent les API pour connecter SharePoint à des sources de données spécifiques, dont ils tirent des informations utiles pour créer des fonctionnalités et des contenus directement intégrés dans les webparts d'un site.

Par exemple, une partie web peut être connectée à une base de données externe pour afficher une liste de projets archivés, permettant aux utilisateurs autorisés d'accéder rapidement aux informations qui les intéressent.

Lorsque les informations d'une source de données connectée à SharePoint via l'API sont mises à jour, le contenu de la partie web peut être synchronisé.

Cependant, la mise à jour en temps réel dépend de la configuration : un rafraîchissement manuel de la page ou la mise en œuvre de solutions personnalisées, telles que des scripts spécifiques ou une fonctionnalité de mise à jour automatique, sont souvent nécessaires.

Les API de SharePoint se répartissent en quatre catégories principales.

Le tableau suivant les présente.

 

SharePoint API : principaux types

 

Types d'API de SharePoint	Description
API REST	Elles permettent d'accéder aux ressources SharePoint et de les manipuler via de simples appels HTTP. Les requêtes RESTful permettent d'effectuer des opérations CRUD (Create, Read, Update, Delete) sur des éléments tels que les listes, les documents et les sites, ce qui en fait un outil clé pour de nombreuses intégrations.
Client-Side Object Model	Ensemble de bibliothèques pouvant être utilisées dans des langages tels que JavaScript, .NET et Silverlight. Les API CSOM sont utiles pour effectuer des opérations côté client, en exécutant du code directement dans le navigateur de l'utilisateur ou dans des applications de bureau.
JavaScript Object Model	Variante de CSOM spécifique à JavaScript, principalement utilisée pour créer des interfaces dynamiques dans les parties web de SharePoint. Il est largement adopté pour la personnalisation des sites d'entreprise.
SOAP Web Services	Bien que moins utilisées que les autres, ces API permettent de communiquer avec SharePoint via des protocoles basés sur XML. Bien qu'elles jouent un rôle secondaire, elles restent utiles dans les scénarios hérités ou pour mettre en œuvre des intégrations particulières.

 

Grâce aux API, nous l'avons dit, Microsoft SharePoint peut être connecté à un large éventail de sources de données et de services externes, notamment des bases de données (comme SQL Server), des services cloud (comme Microsoft Azure) et des systèmes ERP/CRM (comme Dynamics 365 et Salesforce).

Ces intégrations permettent de centraliser les informations au sein de l'intranet d'entreprise ou de tout site basé sur SharePoint Online, ce qui évite aux utilisateurs d'accéder à des systèmes distincts pour obtenir les informations qui les intéressent ou de transférer manuellement les données après chaque mise à jour.

Les API sont donc les éléments fondamentaux pour construire, personnaliser et maintenir toutes les parties web qui enrichissent la fonctionnalité et le contenu d'un site SharePoint, offrant un écosystème puissant et flexible pour répondre à tous les besoins.

 

SharePoint REST API : que sont-elles ?

L'API REST, qui signifie "Representational State Transfer Application Programming Interfaces", est un ensemble de principes architecturaux pour le développement de systèmes de réseaux.

L'architecture REST se concentre sur le concept de ressources. Elle repose sur un modèle de communication dans lequel les clients envoient des demandes aux serveurs pour qu'ils effectuent des actions sur des ressources spécifiques.

Ces demandes prennent généralement la forme de méthodes HTTP telles que GET, POST, PUT, PATCH et DELETE, chacune d'entre elles correspondant à des opérations différentes sur les ressources.

Dans le cas spécifique de SharePoint, les ressources sur lesquelles l'API REST agit peuvent être :

• Les éléments d'une liste
• Les documents d'une bibliothèque
• Un site, dans son intégralité

Les clients peuvent ensuite envoyer des requêtes HTTP pour effectuer des actions sur les ressources, comme récupérer certaines informations ou apporter des modifications.

Un exemple est l'envoi d'une requête GET pour obtenir les détails d'un document dans une bibliothèque SharePoint ; un deuxième exemple peut être une requête POST, souvent utilisée pour ajouter de nouveaux éléments à une liste.

Cette flexibilité fait de l'API REST un outil puissant pour l'intégration et l'automatisation des interactions avec SharePoint, permettant aux développeurs de créer des applications qui s'interfacent facilement avec les données et les fonctionnalités de la plateforme.

D'autres aspects caractérisent l'API REST de SharePoint :

• La facilité d'utilisation, qui permet de travailler efficacement avec des données structurées et non structurées.
  
  
• La sécurité, car l'authentification est gérée par OAuth et des jetons d'accès. Cela signifie que seuls les utilisateurs et les applications autorisés peuvent interagir avec les ressources.
  
  
• L'indépendance du contexte, puisque les requêtes REST peuvent être effectuées à partir de n'importe quel environnement prenant en charge les appels HTTP, y compris les navigateurs et les applications mobiles.
  
  
• L'évolutivité, qui permet de traiter un grand nombre de demandes simultanées sans surcharger le serveur.
  
  

Mais comment l'API REST de SharePoint peut-elle être utilisée dans l'entreprise ?

Comme nous l'avons dit, les API REST sont un outil clé dans l'écosystème de SharePoint Online pour automatiser les processus, intégrer les systèmes et créer des solutions personnalisées pour enrichir les sites tels que l'intranet et l'extranet. Ainsi, un premier cas d'utilisation pourrait être l'automatisation de la gestion des documents.

Un contrat signé, par exemple, peut être chargé dans une bibliothèque SharePoint avec des métadonnées prédéfinies, ce qui permet à l'équipe juridique de le retrouver facilement.

De même, les données archivées peuvent être utilisées pour créer des tableaux de bord interactifs, en les intégrant à des outils tels que Power BI pour surveiller les indicateurs clés de performance ou l'avancement d'un projet.

En outre, il est possible de créer des systèmes de notification ou d'approbation afin de simplifier la gestion des activités. Par exemple, l'utilisation d'API REST permet d'envoyer automatiquement un courriel au responsable lorsqu'un élément d'une liste SharePoint doit être validé.

Les API REST trouvent également une application dans la création de portails pour les employés, tels que ceux créés pour accéder aux documents personnels ou pour envoyer des tickets d'assistance. Là encore, elles peuvent s'intégrer à des systèmes tiers, tels que des outils de gestion de la relation client ou des ressources humaines, pour centraliser les informations sur le personnel, les fournisseurs et les clients.

 

Quelle est la différence entre les API et les REST API dans SharePoint ?

Comme nous l'avons vu, les API sont des ensembles de définitions et de protocoles qui permettent à différents logiciels de communiquer entre eux. Il en existe différents types, notamment les API de bibliothèques, les API de systèmes d'exploitation ou les API de services web, qui peuvent être conçus à l'aide de divers styles architecturaux et de protocoles tels que SOAP, GraphQL et REST.

Les API REST, en particulier, représentent un type d'API qui suit les principes architecturaux de REST (Representational State Transfer).

Ce style se caractérise par un modèle de communication sans état, où chaque demande du client au serveur contient toutes les informations nécessaires pour effectuer l'opération demandée. Les API REST utilisent des méthodes HTTP (GET, POST, PUT, PATCH, DELETE) pour effectuer des opérations sur des ressources, identifiées par des URL uniques.

Ainsi, si toutes les API REST sont des API, toutes les API ne sont pas des API REST.

Même dans le cas de SharePoint, les API REST ne sont qu'un des nombreux moyens permettant d'interagir avec des plateformes et des sources de données externes. Il est utile d'utiliser les API REST pour créer des parties web SharePoint lorsqu'une communication légère et flexible avec des sources de données connectées est nécessaire.

En effet, les API REST permettent de construire des parties web dynamiques et interactives capables de s'interfacer avec une variété de sources de données internes et externes sans compromettre la performance ou la simplicité du code.

D'autres types d'API peuvent servir dans des contextes différents. Par exemple, les API SOAP conviennent mieux dans le cas d'intégrations complexes qui nécessitent un plus grand contrôle de la communication.

De même, les API de type CSOM sont préférées par les développeurs qui travaillent avec un modèle d'objet côté client, offrant une expérience de développement plus naturelle dans les applications.

À quelles sources de données SharePoint peut-il se connecter via les API ?

Grâce aux API, SharePoint Online peut se connecter à un large éventail de sources de données et de programmes pour enrichir les fonctionnalités et le contenu de sites.

Dans le cas de l'intranet d'entreprise, les webparts peuvent tirer parti de l'API de SharePoint pour se connecter aux sources de données suivantes.

 

 

1. Listes et bibliothèques SharePoint

Les webparts peuvent interagir avec les listes et les bibliothèques de SharePoint via des API pour gérer des données structurées telles que des annonces, des contacts, des événements et des tâches.

Cela permet une visualisation intuitive et une modification directe du contenu, y compris des documents commerciaux et des fichiers multimédias, sans avoir à quitter le site SharePoint où se trouve la partie web.

 

Web part pour promouvoir les actualités d'entreprise dans l'intranet SharePoint d'intranet.ai

2. Bases de données externes

Bien que l'API REST de SharePoint ne prenne pas en charge une connexion directe à des bases de données externes, il était auparavant possible d'utiliser les services d'intégration d'applications (Business Connectivity Services, ou BCS) pour se connecter à des bases de données relationnelles ou à des sources OData.

Cependant, Microsoft a définitivement abandonné BCS à partir du 30 septembre 2024.

Aujourd'hui, il est donc conseillé d'utiliser des outils tels que Power Apps et Power Automate pour intégrer de telles informations dans SharePoint, car ils offrent des connecteurs dédiés pour connecter de manière sécurisée et flexible des bases de données relationnelles.

Ces outils permettent également de créer des interfaces intuitives pour gérer les données directement dans l'intranet, sans avoir recours à des solutions intermédiaires.

 

Intégrer des données dans SharePoint via Power Apps

3. Applications de Microsoft 365

Via les API, il est possible d'intégrer dans les webparts de SharePoint des informations provenant des autres produits qui composent le lieu de travail numérique de Microsoft 365.

Il s'agit notamment de :

• OneDrive, pour simplifier la gestion des fichiers personnels et partagés ;
• Outlook, pour intégrer le courrier électronique, les calendriers et les contacts ;
• Teams, pour intégrer le chat, les canaux et d'autres fonctions de collaboration ;
• Planner, pour mettre à jour les tâches d'un projet et coordonner le travail d'équipe.

 

Web part de Microsoft Planner pour SharePoint

4. Services en nuage

Les webparts de SharePoint peuvent communiquer avec les services de Microsoft Azure, notamment Azure Blob Storage, Azure Functions et Azure SQL Database. En outre, elles peuvent produire des rapports et des tableaux de bord avec Power BI.

 

Intégration d'un rapport de Power BI dans SharePoint Online

5. ERP/CRM

Les webparts de SharePoint peuvent obtenir des données de systèmes tels que Microsoft Dynamics 365 et Salesforce. Les informations sur les clients, les ventes et les activités d'assistance deviennent ainsi disponibles sur l'intranet, soutenant le travail des utilisateurs.

Par exemple, l'équipe des ventes pourrait consulter les récentes communications avec les clients gérées par l'équipe d'assistance et obtenir des informations utiles pour gérer les négociations de vente. De même, l'équipe d'assistance peut accéder aux détails des ventes pour analyser les problèmes des clients et proposer des solutions pour les résoudre.

 

Intégration des données de Microsoft Dynamics 365 dans SharePoint

6. Médias sociaux et autres canaux de communication

Les webparts peuvent être intégrées aux profils sociaux de l'entreprise, par exemple les profils LinkedIn ou Twitter, pour afficher les derniers messages publiés sur l'intranet ou mettre en évidence le contenu le plus important pour l'organisation.

 

Web part "Publications sur les réseaux sociaux" d'intranet.ai

Outre les médias sociaux, le contenu au format RSS, comme les nouvelles d'un magazine professionnel en ligne, peut également être importé dans SharePoint.

 

Web part "RSS Feed" d'intranet.ai

SharePoint API et Microsoft Graph API : y a-t-il une relation ?

Microsoft Graph est une plateforme de développement qui offre une passerelle unifiée pour accéder aux données et aux services de Microsoft 365, notamment Azure Active Directory, Outlook, OneDrive, Teams, Excel, Planner et SharePoint.

Elle permet ainsi d'accéder aux multiples services de Microsoft à partir d'un point d'entrée unique, ce qui simplifie grandement le développement et la gestion des applications pour les développeurs.

Graph prend également en charge un large éventail d'opérations, notamment :

• la gestion du courrier et du calendrier dans Outlook ;
• la collaboration et la communication dans Microsoft Teams ;
• l'interaction avec les fichiers et les documents dans OneDrive ;
• la gestion de l'identité des utilisateurs dans Azure Active Directory.

Il existe donc une relation étroite entre les API des produits Microsoft 365 et les API de Microsoft Graph, et SharePoint ne fait pas exception.

L'intégration des SharePoint API dans l'écosystème de Microsoft Graph permet aux développeurs d'accéder aux données et fonctionnalités de SharePoint via les mêmes points de terminaison et jetons d'authentification que ceux utilisés pour les autres services de Microsoft 365.

En pratique, les API de Microsoft Graph fournissent une interface uniforme pour interagir avec les ressources SharePoint, facilitant l'interopérabilité entre SharePoint et d'autres services Microsoft.

Avec Graph, il est possible, par exemple, de récupérer des informations sur un site SharePoint, d'accéder à des documents stockés dans une bibliothèque ou de gérer les autorisations d'accès aux fichiers de l'entreprise. Et ce, de manière simple, par le biais d'appels HTTP.

Il en résulte une plateforme robuste et intégrée qui simplifie le processus de développement, permettant aux entreprises d'exploiter le potentiel de leurs données et de leurs applications.

FAQ sur les API et les REST API de SharePoint

Qu'est-ce que les API de SharePoint et à quoi servent-elles?

Les API de SharePoint sont des ensembles de définitions et de protocoles qui permettent la communication entre SharePoint et d'autres applications ou sources de données externes. Ces API permettent de créer, personnaliser et maintenir les web parts qui composent des sites comme l'intranet d'entreprise, garantissant l'intégration et la mise à jour automatique des contenus.

Qu'est-ce que les REST API de SharePoint et à quoi servent-elles?

Les REST API de SharePoint sont un ensemble de principes architecturaux pour concevoir et développer des systèmes de réseau. Elles permettent l'accès et la manipulation des ressources de SharePoint via de simples appels HTTP, exécutant des opérations CRUD (Create, Read, Update, Delete) sur des éléments tels que des listes, des documents et des sites.

Quelle est la différence entre les API et les REST API dans SharePoint?

Les API sont des ensembles de définitions et de protocoles pour la communication entre différents logiciels, tandis que les REST API représentent un type d'API qui suit les principes architecturaux de REST (Representational State Transfer). Les REST API utilisent des méthodes HTTP pour effectuer des opérations sur les ressources, identifiées par des URL uniques. Toutes les API ne sont pas des REST API, mais toutes les REST API sont des API.

À quelles sources de données SharePoint peut-il se connecter via les API?

SharePoint peut se connecter à une large gamme de sources de données via les API, y compris les listes et bibliothèques de SharePoint, les bases de données externes (telles que SQL Server et Oracle), les applications Microsoft 365 (Outlook, OneDrive, Teams, Planner), les services cloud (Microsoft Azure, Power BI), les systèmes ERP/CRM (Dynamics 365, Salesforce), les outils de Business Intelligence (Tableau, Qlik) et les canaux de communication tels que les réseaux sociaux et les flux RSS.

Existe-t-il une relation entre les API de SharePoint et les API de Microsoft Graph?

Oui, Microsoft Graph est une plateforme qui offre une passerelle unifiée pour accéder aux données et services de Microsoft 365, y compris SharePoint. L'intégration des API de SharePoint dans Microsoft Graph permet aux développeurs d'accéder aux fonctionnalités de SharePoint en utilisant les mêmes points de terminaison et jetons d'authentification que pour les autres services Microsoft 365, simplifiant ainsi l'interopérabilité entre SharePoint et les autres services Microsoft.