SharePoint API en REST API: Waar zijn ze voor?

API's zijn de middelen waarmee verschillende systemen met elkaar communiceren en gegevens en opdrachten uitwisselen. SharePoint, het belangrijkste samenwerkingsplatform in Microsoft 365, maakt gebruik van verschillende soorten API's om gebruikers in staat te stellen de webonderdelen waaruit sites zoals het bedrijfsintranet bestaan, te maken, aan te passen en te onderhouden. Onder deze API's spelen REST API's een belangrijke rol vanwege hun flexibiliteit.

In dit artikel gaan we dieper in op wat SharePoint API's zijn en waarvoor ze worden gebruikt, wat REST API's onderscheidt en welke functionaliteit mogelijk is door integratie met Microsoft Graph.

SharePoint API: Wat zijn ze?

Bij programmeren vertegenwoordigen API's de middelen waarmee een programma kan communiceren met een ander programma of een externe gegevensbron. In het geval van SharePoint maken API's het mogelijk om de webonderdelen van een site, zoals het intranet, te creëren.

Ontwikkelaars gebruiken dan API's om SharePoint te verbinden met specifieke gegevensbronnen, waaruit ze de informatie halen die nodig is om inhoud en functionaliteit te leveren in de webonderdelen waaruit een site bestaat.

Wanneer informatie van een gegevensbron die via API's met SharePoint is verbonden, wordt bijgewerkt, is het belangrijk op te merken dat de inhoud van het gerelateerde webonderdeel automatisch en in realtime wordt bijgewerkt.

SharePoint API's vallen uiteen in vier hoofdcategorieën:

1. REST API's, die toegang tot en manipulatie van SharePoint-bronnen mogelijk maken met eenvoudige HTTP-aanroepen. Over het algemeen voeren RESTful requests CRUD (Create, Read, Update, Delete) operaties uit op items in SharePoint zoals lijsten, documenten en sites.
   
   
2. Client-Side Object Model (CSOM): het type API dat een set bibliotheken biedt voor gebruik in talen zoals JavaScript, .NET en Silverlight voor interactie met SharePoint. Deze API's zijn nuttig voor het uitvoeren van bewerkingen aan de clientzijde, omdat hierbij code rechtstreeks in de browser van de gebruiker wordt uitgevoerd.
   
   
3. JavaScript Object Model (JOM): een categorie API's die lijkt op CSOM, maar specifiek is voor JavaScript. Het wordt daarom vaak gebruikt om de dynamische interfaces van SharePoint webonderdelen te maken.
   
   
4. SOAP Web Services: hoewel minder veel gebruikt dan de andere API's, maken deze API's het mogelijk om met SharePoint te communiceren via op XML gebaseerde protocollen.
   
   

SharePoint's set API's maakt het mogelijk om webonderdelen te verbinden met een breed scala aan gegevensbronnen, waaronder externe databases (bijv. SQL Server), cloudservices (zoals Microsoft Azure), ERP/CRM-systemen (bijv. Dynamics 365 en Salesforce) en een groot aantal andere services en applicaties.

Als we de API-verbinding met een SQL Server als voorbeeld nemen, kan een webonderdeel de lijst met projecten weergeven die in de database is opgeslagen. Dankzij deze integratie kunnen geautoriseerde gebruikers de informatie waarin ze geïnteresseerd zijn rechtstreeks in het SharePoint-intranet bekijken, zonder dat ze toegang moeten krijgen tot afzonderlijke systemen of handmatig gegevens moeten overdragen na een update.

Dit is wat SharePoint API's zijn: de bouwstenen die we nodig hebben om alle webonderdelen te bouwen, aan te passen en te onderhouden die de functionaliteit en inhoud van een SharePoint-site verrijken.

SharePoint REST API: Wat zijn ze?

REST API's, wat staat voor Representational State Transfer Application Programming Interfaces, zijn een set architectuurprincipes voor het ontwerpen en ontwikkelen van netwerksystemen.

De REST-architectuur richt zich op het concept van bronnen. Ze zijn in feite gebaseerd op een communicatiemodel waarbij clients verzoeken sturen naar servers om acties uit te voeren op specifieke bronnen. Deze verzoeken nemen meestal de vorm aan van HTTP-methodes zoals GET, POST, PUT, PATCH en DELETE, die elk overeenkomen met verschillende bewerkingen op de bronnen.

In het specifieke geval van SharePoint kunnen de bronnen waarop de REST API werkt, zijn:

• De elementen van een lijst
• De documenten van een bibliotheek
• Een site, in zijn geheel

Clients kunnen vervolgens HTTP-verzoeken sturen om acties uit te voeren op de bronnen, zoals het ophalen van bepaalde informatie of het aanbrengen van wijzigingen. Een voorbeeld is het sturen van een GET-verzoek om de details van een document in een SharePoint-bibliotheek op te vragen; een tweede voorbeeld kan een POST-verzoek zijn, vaak gebruikt om items aan een lijst toe te voegen.

Deze flexibiliteit maakt REST API's tot een krachtig hulpmiddel voor het integreren en automatiseren van interacties met SharePoint, zodat ontwikkelaars toepassingen kunnen bouwen die eenvoudig kunnen interfacen met de gegevens en functionaliteit van het platform.

Andere aspecten die kenmerkend zijn voor de REST API's van SharePoint zijn:

1. Gebruiksgemak, waardoor ze efficiënt kunnen werken met gestructureerde en ongestructureerde gegevens.
2. Beveiliging, omdat authenticatie wordt afgehandeld via OAuth en toegangstokens. Dit betekent dat alleen geautoriseerde gebruikers en applicaties kunnen communiceren met bronnen.
3. Contextonafhankelijkheid, omdat REST-verzoeken kunnen worden gedaan vanuit elke omgeving die HTTP-oproepen ondersteunt, inclusief browsers en mobiele applicaties.
4. Schaalbaarheid, waardoor een groot aantal gelijktijdige verzoeken kan worden afgehandeld zonder de server te overbelasten.

Wat is het verschil tussen API en REST API in SharePoint?

Zoals we hebben gezien, zijn API's sets van definities en protocollen waarmee verschillende software met elkaar kunnen communiceren. Er zijn verschillende soorten, waaronder bibliotheek-API's, API's voor besturingssystemen of webservice-API's, die kunnen worden ontworpen met behulp van verschillende architecturale stijlen en protocollen, zoals SOAP, GraphQL en REST.

REST API's vertegenwoordigen een type API dat de architectuurprincipes van REST (Representational State Transfer) volgt. Deze stijl wordt gekenmerkt door een stateloos communicatiemodel, waarbij elk clientverzoek aan de server alle informatie bevat die nodig is om de gevraagde bewerking uit te voeren. REST API's gebruiken HTTP-methoden (GET, POST, PUT, PATCH, DELETE) om bewerkingen uit te voeren op bronnen, geïdentificeerd door unieke URL's.

Dus: hoewel alle REST API's API's zijn, zijn niet alle API's REST API's.

Zelfs in het geval van SharePoint zijn REST API's slechts een van de vele manieren waarop u kunt communiceren met externe platforms en gegevensbronnen. Het is nuttig om REST API's te gebruiken om SharePoint webonderdelen te maken wanneer lichte en flexibele communicatie met gerelateerde gegevensbronnen nodig is.

REST API's maken het in feite mogelijk om dynamische, interactieve webonderdelen te maken die kunnen interfacen met een verscheidenheid aan interne en externe gegevensbronnen zonder afbreuk te doen aan de prestaties of de eenvoud van de code.

Andere soorten API's kunnen in verschillende contexten worden gebruikt. SOAP API's zijn bijvoorbeeld beter geschikt voor complexe integraties waarbij meer controle over de communicatie nodig is. Op dezelfde manier hebben CSOM-type API's de voorkeur van ontwikkelaars die werken met een client-side objectmodel, wat zorgt voor een natuurlijkere ontwikkelervaring in applicaties.

Met welke gegevensbronnen kan SharePoint via API's verbinding maken?

Via zijn API kan SharePoint verbinding maken met een groot aantal gegevensbronnen en programma's om zijn functionaliteit en inhoud op sites zoals het intranet te verrijken.

In het geval van intranet kunnen webonderdelen SharePoint's API gebruiken om verbinding te maken met de volgende gegevensbronnen.

1. SharePoint-lijsten en -bibliotheken

Webonderdelen kunnen dan gestructureerde gegevens beheren, zoals aankondigingen, contactpersonen, evenementen en activiteiten. Ze maken het ook gemakkelijk om inhoud in SharePoint-opslagplaatsen, zoals bedrijfsdocumenten of mediabestanden, te bekijken en te bewerken.

2. Externe databases

Webonderdelen maken verbinding met SQL Server-databases, zodat intranetgebruikers direct toegang hebben tot gearchiveerde informatie zonder van omgeving te hoeven veranderen. Daarnaast kunnen webonderdelen via API's ook verbinding maken met databasemanagementsystemen, zoals Oracle, om zo een gecentraliseerde weergave van bedrijfsgegevens te bieden.

3. Microsoft 365-toepassingen

Informatie uit de andere producten die deel uitmaken van de Microsoft 365 digitale werkplek (waarvan SharePoint een onderdeel is) kan via API's worden geïntegreerd in SharePoint webonderdelen. Deze producten omvatten:

• Outlook, om e-mail, agenda en contactpersonen te integreren.
• OneDrive, om het beheer van persoonlijke en gedeelde bestanden te vereenvoudigen.
• Teams, om chat, kanalen en andere samenwerkingsfuncties te integreren.
• Planner, om projectactiviteiten bij te werken en teamwerk te coördineren.

4. Clouddiensten

SharePoint webonderdelen kunnen communiceren met Microsoft Azure services, waaronder Azure Blob Storage, Azure Functions en Azure SQL Database. Bovendien kunnen ze rapporteren over Power BI-rapporten en dashboards.

5. ERP/CRM

Webonderdelen kunnen gegevens verkrijgen uit systemen zoals Microsoft Dynamics 365 en Salesforce. Informatie over klanten, verkoop- en ondersteuningsactiviteiten wordt zo doorzoekbaar op het intranet, wat het werk van gebruikers ondersteunt.

Het salesteam kan bijvoorbeeld recente klantcommunicaties bekijken die door het supportteam zijn beheerd en inzichten opdoen die nuttig zijn voor het beheren van zakelijke onderhandelingen. Op dezelfde manier kan het ondersteuningsteam verkoopgegevens inzien om problemen van klanten te analyseren en oplossingen op maat voor te stellen.

6. Tools voor bedrijfsinformatie

Naast Power BI kunnen SharePoint webonderdelen via API verbinding maken met Tableau en Qlik. Dit zijn enkele van de populairste en meest gebruikte tools in bedrijven voor gegevensanalyse en integratie met SharePoint zorgt voor gecentraliseerde toegang tot informatie in het intranet en stroomlijnt zo besluitvormingsprocessen.

7. Sociale media en andere communicatiekanalen

Webonderdelen kunnen worden geïntegreerd met de sociale profielen van het bedrijf, bijvoorbeeld die van LinkedIn of Twitter, om in het intranet de laatst gepubliceerde berichten te tonen of de belangrijkste inhoud voor het bedrijf uit te lichten. Naast sociale media kan ook inhoud in RSS-formaat (bijvoorbeeld nieuws uit een online vakblad) in SharePoint worden geïmporteerd.

Bij intranet.ai hebben we juist op dit gebruik van de SharePoint API voortgebouwd om de webonderdelen "Berichten in sociale media" en "RSS-feed" te maken, waarmee onze klanten de inhoud van het intranet dat we samen hebben gebouwd, eenvoudig kunnen verrijken.

SharePoint API en Microsoft Graph API:
is er een verband?

Microsoft Graph is een ontwikkelaarsplatform dat een uniforme gateway biedt voor toegang tot Microsoft 365-gegevens en -diensten, waaronder Azure Active Directory, Outlook, OneDrive, Teams, Excel, Planner en SharePoint.

Het biedt dus toegang tot de verschillende diensten van Microsoft vanaf één enkel toegangspunt, wat de ontwikkeling en het beheer van toepassingen voor ontwikkelaars sterk vereenvoudigt. Graph ondersteunt ook een breed scala aan bewerkingen, waaronder:

• interactie met bestanden en documenten in OneDrive
• mail- en agendabeheer in Outlook
• samenwerking en communicatie in Microsoft Teams
• beheer van gebruikersidentiteiten in Azure Active Directory

Er is dus een nauwe relatie tussen Microsoft 365 product API's en Microsoft Graph API's, en SharePoint is daarop geen uitzondering.

De integratie van SharePoint API's in het Microsoft Graph ecosysteem stelt ontwikkelaars in staat om toegang te krijgen tot SharePoint gegevens en functionaliteit via dezelfde endpoints en authenticatie tokens die worden gebruikt voor andere Microsoft 365 services. In de praktijk bieden de Microsoft Graph API's een uniforme interface voor interactie met SharePoint-bronnen, waardoor interoperabiliteit tussen SharePoint en andere Microsoft 365-services gemakkelijker wordt.

Met Microsoft Graph is het bijvoorbeeld mogelijk om informatie op te halen op een SharePoint-site, toegang te krijgen tot documenten die zijn opgeslagen in een bibliotheek of om toegangsrechten tot bedrijfsbestanden te beheren. Eenvoudig, via HTTP-oproepen.

Het resultaat is een robuust, geïntegreerd platform dat het ontwikkelingsproces vereenvoudigt, zodat bedrijven het volledige potentieel van hun gegevens en toepassingen kunnen benutten.

Wat zijn SharePoint API's en waarvoor worden ze gebruikt?

SharePoint API's zijn sets van definities en protocollen die communicatie tussen SharePoint en andere applicaties of externe gegevensbronnen mogelijk maken. Deze API's stellen u in staat om webonderdelen te maken, aan te passen en te onderhouden die websites zoals het bedrijfsintranet vormen, waarbij integratie en automatische inhoudsupdates worden gegarandeerd.

Wat zijn SharePoint REST API's en waarvoor worden ze gebruikt?

SharePoint REST API's zijn een verzameling architectonische principes voor het ontwerpen en ontwikkelen van netwerksystemen. Ze maken toegang tot en manipulatie van SharePoint-resources mogelijk via eenvoudige HTTP-aanroepen, waarbij CRUD-operaties (Create, Read, Update, Delete) worden uitgevoerd op elementen zoals lijsten, documenten en sites.

Wat is het verschil tussen API's en REST API's in SharePoint?

API's zijn sets van definities en protocollen voor communicatie tussen verschillende software, terwijl REST API's een type API vertegenwoordigen dat de architectonische principes van REST (Representational State Transfer) volgt. REST API's gebruiken HTTP-methoden om bewerkingen op resources uit te voeren, die worden geïdentificeerd door unieke URL's. Niet alle API's zijn REST API's, maar alle REST API's zijn API's.

Met welke gegevensbronnen kan SharePoint via API's verbinding maken?

SharePoint kan via API's verbinding maken met een breed scala aan gegevensbronnen, waaronder SharePoint-lijsten en -bibliotheken, externe databases (zoals SQL Server en Oracle), Microsoft 365-toepassingen (Outlook, OneDrive, Teams, Planner), clouddiensten (Microsoft Azure, Power BI), ERP/CRM-systemen (Dynamics 365, Salesforce), business intelligence-tools (Tableau, Qlik) en communicatiekanalen zoals sociale media en RSS-feeds.

Is er een relatie tussen SharePoint API's en Microsoft Graph API's?

Ja, Microsoft Graph is een platform dat een uniforme gateway biedt voor toegang tot gegevens en diensten in Microsoft 365, inclusief SharePoint. De integratie van SharePoint API's in Microsoft Graph stelt ontwikkelaars in staat om toegang te krijgen tot de functionaliteiten van SharePoint via dezelfde eindpunten en authenticatietokens die worden gebruikt voor andere Microsoft 365-diensten, waardoor de interoperabiliteit tussen SharePoint en andere Microsoft-diensten wordt vereenvoudigd.