SharePoint API et REST API : à quoi servent-elles ?
Les API sont les moyens par lesquels différents systèmes communiquent entre eux, en échangeant des données et des commandes. SharePoint, la principale plateforme de collaboration de Microsoft 365, exploite différents types d'API pour permettre aux utilisateurs de créer, de personnaliser et de maintenir les parties web qui composent les sites tels que l'intranet de l'entreprise. Parmi ces API, les API REST jouent un rôle important en raison de leur flexibilité.
Dans cet article, nous verrons en détail ce que sont les API de SharePoint et à quoi elles servent, ce qui distingue les API REST et quelles fonctionnalités sont possibles grâce à l'intégration avec Microsoft Graph.
Ce que vous trouverez dans cet article
SharePoint API : que sont-elles ?
En programmation, 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, les API permettent de créer les parties web d'un site tel que l'intranet.
Les développeurs utilisent ensuite les API pour connecter SharePoint à des sources de données spécifiques, dont ils tirent les informations nécessaires pour offrir du contenu et des fonctionnalités dans les parties web qui composent un site.
Lorsque les informations d'une source de données connectée à SharePoint via une API sont mises à jour, il est important de noter que le contenu de la partie web concernée est mis à jour automatiquement et en temps réel.
Les API de SharePoint se répartissent en quatre catégories principales :
- REST API, qui permettent d'accéder aux ressources SharePoint et de les manipuler à l'aide de simples appels HTTP. En général, les requêtes RESTful effectuent des opérations CRUD (Create, Read, Update, Delete) sur des éléments de SharePoint tels que des listes, des documents et des sites.
- Client-Side Object Model (CSOM) : Le type d'API qui fournit un ensemble de bibliothèques à utiliser dans des langages tels que JavaScript, .NET et Silverlight pour interagir avec SharePoint. Ces API sont utiles pour effectuer des opérations côté client, car elles impliquent l'exécution du code directement dans le navigateur de l'utilisateur.
- JavaScript Object Model (JOM) : une catégorie d'API similaire à CSOM, mais spécifique à JavaScript. Il est donc souvent utilisé pour créer les interfaces dynamiques des parties web de SharePoint.
- 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.
L'ensemble des API de SharePoint permet de connecter les webparts à un large éventail de sources de données, y compris des bases de données externes (par exemple SQL Server), des services cloud (par exemple Microsoft Azure), des systèmes ERP/CRM (par exemple Dynamics 365 et Salesforce), ainsi qu'une multitude d'autres services et applications.
Si l'on prend l'exemple d'une connexion API avec un serveur SQL, une partie web pourrait afficher la liste des projets stockés dans la base de données. Cette intégration permet aux utilisateurs autorisés de consulter les informations qui les intéressent directement dans l'intranet SharePoint, sans avoir à accéder à des systèmes distincts ou à transférer manuellement les données après une mise à jour.
Voilà donc ce que sont les API SharePoint : les éléments de base dont nous avons besoin pour construire, personnaliser et maintenir toutes les parties web qui enrichissent la fonctionnalité et le contenu de n'importe quel site SharePoint.
Qu'est-ce qu’intranet.ai ?
intranet.ai est l'intranet d'entreprise prêt à l'emploi, conçu pour réduire les coûts et les délais de mise en œuvre, créant un environnement de travail numérique collaboratif et moderne :
- Prix de départ de 3 650 €/an pour une intranet complète
- 50+ applications, dont la recherche avancée, le système de gestion de documents, les notifications push via Teams, le profil personnel et les pages FAQ
- Intégration à 100 % avec SharePoint Online et Microsoft 365
SharePoint REST API : que sont-elles ?
L'API REST, qui signifie Representational State Transfer Application Programming Interfaces, est un ensemble de principes architecturaux pour la conception et le développement de systèmes en réseau.
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 serait l'envoi d'une requête GET pour obtenir les détails d'un document dans une bibliothèque SharePoint ; un deuxième exemple pourrait être une requête POST, souvent utilisée pour ajouter des é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.
- 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.
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.
A quelles sources de données SharePoint peut-il se connecter via les API ?
Grâce à son API, SharePoint peut se connecter à un large éventail de sources de données et de programmes pour enrichir les fonctionnalités et le contenu de sites tels que l'intranet.
Dans le cas de l'intranet, les webparts peuvent profiter de l'API de SharePoint pour se connecter aux sources de données suivantes.
1. Listes et bibliothèques SharePoint
Les webparts permettent de gérer des données structurées telles que des annonces, des contacts, des événements et des activités. Elles facilitent également la visualisation et la modification du contenu des référentiels SharePoint, tels que les documents commerciaux ou les fichiers multimédias.
2. Bases de données externes
Les Webparts se connectent aux bases de données SQL Server, ce qui permet aux utilisateurs de l'intranet d'accéder directement aux informations archivées sans changer d'environnement. En outre, les API permettent également aux Webparts de se connecter à des systèmes de gestion de base de données, tels qu'Oracle, afin de fournir une vue centralisée des données de l'entreprise.
3. Applications Microsoft 365
Les informations provenant des autres produits qui composent l'espace de travail numérique Microsoft 365 (dont SharePoint fait partie) peuvent être intégrées dans les webparts SharePoint via des API. Ces produits sont notamment :
- Outlook, pour intégrer le courrier électronique, le calendrier et les contacts.
- OneDrive, pour simplifier la gestion des fichiers personnels et partagés.
- Teams, pour intégrer le chat, les canaux et d'autres fonctions de collaboration.
- Planner, pour mettre à jour les activités d'un projet et coordonner le travail d'équipe.
4. Services dans le nuage
Les webparts SharePoint peuvent communiquer avec les services Microsoft Azure, notamment Azure Blob Storage, Azure Functions et Azure SQL Database. En outre, elles peuvent produire des rapports et des tableaux de bord Power BI.
5. ERP/CRM
Les parties web peuvent obtenir des données à partir de systèmes tels que Microsoft Dynamics 365 et Salesforce. Les informations sur les clients, les ventes et les activités de support deviennent ainsi disponibles sur l'intranet, soutenant le travail des utilisateurs.
Par exemple, l'équipe des ventes peut consulter les communications récentes avec les clients gérées par l'équipe d'assistance et obtenir des informations utiles pour gérer les négociations commerciales. 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 personnalisées.
6. Outils de veille stratégique
Outre Power BI, les parties web de SharePoint peuvent se connecter via une API à Tableau et Qlik. Ces outils sont parmi les plus populaires et les plus utilisés dans les entreprises pour l'analyse des données, et l'intégration avec SharePoint permet un accès centralisé à l'information sur l'intranet et donc des processus de prise de décision optimisés.
7. Médias sociaux et autres canaux de communication
Les parties web peuvent être intégrées aux profils sociaux de l'entreprise, par exemple ceux de LinkedIn ou de Twitter, afin d'afficher les derniers messages publiés sur l'intranet ou de mettre en évidence les contenus les plus importants pour l'entreprise. Outre les médias sociaux, il est également possible d'importer dans SharePoint des contenus au format RSS (par exemple les nouvelles d'un magazine professionnel en ligne).
Chez intranet.ai, nous nous sommes basés sur cette utilisation de l'API SharePoint pour créer les webparts "Publications sur les réseaux sociaux" et "RSS Feed", avec lesquels nos clients peuvent facilement enrichir le contenu de l'intranet que nous avons construit ensemble.
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
- l'interaction avec les fichiers et les documents dans OneDrive
- la gestion du courrier et du calendrier dans Outlook
- la collaboration et la communication dans Microsoft Teams
- 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 API SharePoint dans l'écosystème Microsoft Graph permet aux développeurs d'accéder aux données et fonctionnalités SharePoint via les mêmes points de terminaison et jetons d'authentification que ceux utilisés pour les autres services Microsoft 365. En pratique, les API Microsoft Graph fournissent une interface uniforme pour interagir avec les ressources SharePoint, facilitant l'interopérabilité entre SharePoint et d'autres services Microsoft 365.
Avec Microsoft 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 pleinement le potentiel de leurs données et de leurs applications.
Vous voulez un intranet SharePoint complet, intelligent et intégré à Microsoft 365 ?
- Nous vous proposons un intranet de marque prêt à l'emploi.
- Nous dépassons les limites d'un site d'entreprise standard grâce à plus de 50 fonctionnalités pour la communication interne, la formation, la gestion des connaissances et la productivité.
- Nous mettons à jour tous les composants selon les dernières normes Microsoft.
Giuseppe Marchi
Microsoft MVP pour SharePoint et Microsoft 365 depuis 2010.
Giuseppe est le fondateur d'intranet.ai et l'un des plus grands experts en Italie en ce qui concerne Microsoft 365. Depuis des années, il aide les entreprises à créer leur propre environnement de travail numérique dans le cloud de Microsoft, en veillant à l'expérience des utilisateurs.
FAQ sur les API de SharePoint et les REST API
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.
Lire la suite
Qu'est-ce que SharePoint et ses 7 fonctionnalités clés
Quelles sont les fonctionnalités à exploiter pour votre entreprise ? Découvrez tout cela et bien plus encore.