SharePoint API und REST API: Was sind sie?

APIs ermöglichen die Kommunikation zwischen unterschiedlichen Systemen durch den Austausch von Daten und Befehlen.

SharePoint Online, die zentrale Kollaborationsplattform in Microsoft 365, nutzt verschiedene Arten von APIs, um es den Nutzern zu ermöglichen, die Webparts, aus denen Websites wie das Firmen-Intranet bestehen, zu erstellen, anzupassen und zu verwalten. Unter diesen APIs spielen die REST-APIs eine besonders wichtige Rolle aufgrund ihrer Flexibilität.

Hier werden wir betrachten, was die SharePoint-APIs sind und wofür sie genutzt werden, was die REST-APIs auszeichnet und welche Funktionen durch die Integration mit Microsoft Graph möglich sind.

Was Sie in diesem Artikel finden

• Wofür sind sie?

• SharePoint REST API: Wofür sind sie?

• Was ist der Unterschied zwischen APIs und REST APIs in SharePoint?

• Mit welchen Datenquellen kann SharePoint über APIs verbunden werden?

• SharePoint API und Microsoft Graph API: gibt es eine Beziehung?

Wofür sind sie?

APIs sind die Mittel, über die ein Programm mit einem anderen Programm oder einer externen Datenquelle kommunizieren kann. Im Falle von SharePoint Online ermöglichen APIs die Anreicherung einer Website, z. B. eines Unternehmensintranets, durch die Entwicklung von maßgeschneiderten und dynamischen Komponenten.

Entwickler verwenden APIs, um SharePoint mit bestimmten Datenquellen zu verbinden, aus denen sie Informationen ableiten, die für die Erstellung von Funktionen und Inhalten nützlich sind, die direkt in die Webparts einer Website integriert werden.

So kann beispielsweise ein Webpart mit einer externen Datenbank verbunden werden, um eine Liste archivierter Projekte anzuzeigen und autorisierten Benutzern einen schnellen Zugriff auf die gewünschten Informationen zu ermöglichen.

Wenn Informationen in einer Datenquelle, die über eine API mit SharePoint verbunden ist, aktualisiert werden, kann der Inhalt des Webparts synchronisiert werden.

Die Aktualisierung in Echtzeit ist jedoch konfigurationsabhängig: Häufig ist eine manuelle Seitenaktualisierung oder die Implementierung kundenspezifischer Lösungen, wie z. B. spezifische Skripte oder automatische Aktualisierungsfunktionen, erforderlich.

Die SharePoint-APIs lassen sich in vier Hauptkategorien einteilen.

Diese werden in der folgenden Tabelle dargestellt.

Haupttypen

Arten von SharePoint API Beschreibung

REST-API Sie ermöglichen den Zugriff auf und die Manipulation von SharePoint-Ressourcen über einfache HTTP-Aufrufe. RESTful-Anfragen ermöglichen CRUD-Operationen (Erstellen, Lesen, Aktualisieren, Löschen) für Elemente wie Listen, Dokumente und Websites, was sie zu einem wichtigen Werkzeug für viele Integrationen macht.

Client-Side Object Model Eine Reihe von Bibliotheken, die in Sprachen wie JavaScript, .NET und Silverlight verwendet werden können. CSOM-APIs sind nützlich für die Durchführung clientseitiger Operationen, die Ausführung von Code direkt im Browser des Benutzers oder in Desktop-Anwendungen.

JavaScript Object Model Eine JavaScript-spezifische Variante von CSOM, die hauptsächlich zur Erstellung dynamischer Schnittstellen in SharePoint-Webparts verwendet wird. Es wird häufig für die Anpassung von Unternehmenswebsites verwendet.

SOAP Web Services Diese APIs sind zwar weniger weit verbreitet als die anderen, ermöglichen aber die Kommunikation mit SharePoint über XML-basierte Protokolle. Obwohl sie eine untergeordnete Rolle spielen, sind sie in Legacy-Szenarien oder zur Implementierung bestimmter Integrationen weiterhin nützlich.

Dank der APIs kann SharePoint, wie bereits erwähnt, mit einer Vielzahl von externen Datenquellen und Diensten verbunden werden, darunter Datenbanken (wie SQL Server), Cloud-Dienste (wie Microsoft Azure) und ERP/CRM-Systeme (wie Dynamics 365 und Salesforce).

Diese Integrationen ermöglichen die Zentralisierungvon Informationen im Firmen-Intranet oder auf einer SharePoint Online-Site, so dass die Benutzer nicht mehr auf separate Systeme zugreifen müssen, um die gewünschten Informationen zu erhalten, oder die Daten nach jeder Aktualisierung manuell übertragen müssen.

APIs sind daher die grundlegenden Bausteine für die Erstellung, Anpassung und Pflege aller Webparts, die die Funktionalität und den Inhalt einer SharePoint-Website bereichern, und bieten ein leistungsfähiges und flexibles Ökosystem, das allen Anforderungen gerecht wird.

Was sind sie und wofür werden sie verwendet?

SharePoint REST API: Wofür sind sie?

Die REST-APIs, kurz für Representational State Transfer Application Programming Interfaces, sind eine Reihe architektonischer Prinzipien zur Gestaltung und Entwicklung von Netzwerksystemen.

Die REST-Architektur konzentriert sich auf das Konzept von Ressourcen. Sie basiert auf einem Kommunikationsmodell, bei dem Clients Anfragen an Server senden, um Aktionen auf spezifischen Ressourcen auszuführen.

Diese Anfragen erfolgen typischerweise in Form von HTTP-Methoden wie GET, POST, PUT, PATCH und DELETE, wobei jede Methode einer bestimmten Operation auf den Ressourcen entspricht.

Im speziellen Fall von SharePoint können die Ressourcen, auf die REST-APIs zugreifen, Folgendes umfassen:

• Elemente einer Liste

• Dokumente in einer Bibliothek

• Eine gesamte Website

Clients können also HTTP-Anfragen senden, um Aktionen an den Ressourcen durchzuführen, z. B. bestimmte Informationen abzurufen oder Änderungen vorzunehmen.

Ein Beispiel ist eine GET-Anfrage, um die Details eines Dokuments in einer SharePoint-Bibliothek abzurufen. Eine weitere Möglichkeit ist eine POST-Anfrage, die häufig verwendet wird, um neue Elemente zu einer Liste hinzuzufügen.

Diese Flexibilität macht REST-APIs zu einem leistungsstarken Werkzeug zur Integration und Automatisierung von Interaktionen mit SharePoint. Sie ermöglichen Entwicklern, Anwendungen zu erstellen, die sich problemlos mit den Daten und Funktionen der Plattform verbinden.

Weitere Merkmale der SharePoint REST-APIs sind:

• Benutzerfreundlichkeit, da sie eine effiziente Arbeit mit strukturierten und unstrukturierten Daten ermöglichen.

• Sicherheit, da die Authentifizierung über OAuth und Zugriffstoken verwaltet wird. Dies stellt sicher, dass nur autorisierte Benutzer und Anwendungen mit den Ressourcen interagieren können.

• Unabhängigkeit vom Kontext, da REST-Anfragen aus jeder Umgebung gesendet werden können, die HTTP-Aufrufe unterstützt, einschließlich Browsern und mobilen Anwendungen.

• Skalierbarkeit, da sie eine große Anzahl gleichzeitiger Anfragen verarbeiten können, ohne den Server zu überlasten.

Aber wie können die SharePoint REST-APIs konkret im Unternehmen genutzt werden?

Wie bereits erwähnt, sind REST-APIs ein zentrales Werkzeug im SharePoint-Online-Ökosystem, um Prozesse zu automatisieren, Systeme zu integrieren und maßgeschneiderte Lösungen zu erstellen, die Plattformen wie die Intranet oder Extranet bereichern.

Ein erstes Anwendungsbeispiel könnte die Automatisierung des Dokumentenmanagements sein.

Ein unterzeichneter Vertrag kann beispielsweise mit vordefinierten Metadaten in eine SharePoint-Bibliothek hochgeladen werden, sodass er für das Rechtsabteilungsteam leicht auffindbar ist.

Ebenso können gespeicherte Daten zur Erstellung interaktiver Dashboards genutzt werden, indem sie mit Tools wie Power BI integriert werden, um KPIs oder den Fortschritt eines Projekts zu überwachen.

Darüber hinaus können Benachrichtigungs- oder Genehmigungssysteme erstellt werden, um die Verwaltung täglicher Aufgaben zu erleichtern.

Ein Beispiel wäre hier die Nutzung der REST-APIs zum automatischen Versand einer E-Mail an die verantwortliche Person, wenn ein in eine bestimmte SharePoint-Liste eingetragenes Element seine Genehmigung erfordert.

REST-APIs finden auch Anwendung bei der Erstellung von Mitarbeiterportalen, die den Zugriff auf persönliche Dokumente oder das Einreichen von Support-Tickets ermöglichen.

Zudem können sie mit Drittanbietersystemen wie CRM- oder HR-Management-Tools integriert werden, um Informationen über Mitarbeiter, Lieferanten und Kunden zentral zu verwalten.

Was ist der Unterschied zwischen APIs und REST APIs in SharePoint?

Wie wir bereits gesehen haben, handelt es sich bei APIs um Definitionen und Protokolle, die es verschiedenen Programmen ermöglichen, miteinander zu kommunizieren.

Es gibt verschiedene Arten, darunter Bibliotheks-APIs, Betriebssystem-APIs oder Webservice-APIs, die unter Verwendung verschiedener Architekturstile und Protokolle wie SOAP, GraphQL und REST entwickelt werden können.

REST-APIs sind eine Art von API, die den architektonischen Grundsätzen von REST (Representational State Transfer) folgt. Dieser Stil zeichnet sich durch ein zustandsloses Kommunikationsmodell aus, bei dem jede Anfrage des Clients an den Server alle Informationen enthält, die für die Durchführung der angeforderten Operation erforderlich sind.

REST-APIs verwenden HTTP-Methoden (GET, POST, PUT, PATCH, DELETE), um Operationen an Ressourcen durchzuführen, die durch eindeutige URLs gekennzeichnet sind.

Während alle REST-APIs APIs sind,sind nicht alle APIs REST-APIs.

Selbst im Fall von SharePoint sind REST-APIs nur eine von vielen Möglichkeiten, um mit externen Plattformen und Datenquellen zu interagieren.

Die Verwendung von REST-APIs zur Erstellung von SharePoint-Webparts ist dann sinnvoll, wenn eine leichte und flexible Kommunikation mit verbundenen Datenquellen erforderlich ist.

REST-APIs ermöglichen die Erstellung dynamischer, interaktiver Webparts, die mit einer Vielzahl interner und externer Datenquellen interagieren können, ohne die Leistung oder Einfachheit des Codes zu beeinträchtigen.

Andere Arten von APIs können in unterschiedlichen Kontexten eingesetzt werden. SOAP-APIs eignen sich beispielsweise besser für komplexe Integrationen, die eine größere Kontrolle über die Kommunikation erfordern.

Ebenso werden APIs vom Typ CSOM von Entwicklern bevorzugt, die mit einem clientseitigen Objektmodell arbeiten, das eine natürlichere Entwicklungserfahrung in Anwendungen bietet.

Mit welchen Datenquellen kann SharePoint über APIs verbunden werden?

Dank der APIs kann SharePoint Online eine Verbindung zu einer Vielzahl von Datenquellen und Programmen herstellen, um die Funktionalität und den Inhalt von Websites zu erweitern. Gerade im Fall des Firmen-Intranets können Webparts die Vorteile der SharePoint-API nutzen, um sich mit den folgenden Datenquellen zu verbinden.

1. SharePoint-Listen und -Bibliotheken

Webparts können über APIs mit SharePoint-Listen und -Bibliotheken interagieren, um strukturierte Daten wie Ankündigungen, Kontakte, Ereignisse und Aufgaben zu verwalten.

Dies ermöglicht die intuitive Anzeige und direkte Bearbeitung von Inhalten, einschließlich Geschäftsdokumenten und Mediendateien, ohne dass die SharePoint-Website, auf der sich das Webpart befindet, verlassen werden muss.

2. Externe Datenbanken

Obwohl die REST-API von SharePoint keine direkte Verbindung zu externen Datenbanken unterstützt, war es früher möglich, die Anwendungsintegrationsdienste (Business Connectivity Services, BCS) zu verwenden, um eine Verbindung zu relationalen Datenbanken oder OData-Quellen herzustellen.

Microsoft hat BCS jedoch zum 30. September 2024 endgültig eingestellt.

Heute ist es daher ratsam, Tools wie Power Apps und Power Automatezu verwenden, um diese Informationen in SharePoint zu integrieren, da sie spezielle Konnektoren für eine sichere und flexible Verbindung zu relationalen Datenbanken bieten.

Mit diesen Tools lassen sich auch intuitive Schnittstellen zur Verwaltung der Daten direkt im Intranet erstellen, ohne dass Zwischenlösungen erforderlich sind.

3. Microsoft 365-Anwendungen

Über APIs lassen sich Informationen aus anderen Microsoft 365-Produkten, die den digitalen Arbeitsplatz bilden, in SharePoint-Webparts integrieren.

Dazu gehören:

• Outlook, um E-Mails, Kalender und Kontakte einzubinden.

• OneDrive, um die Verwaltung persönlicher und gemeinsamer Dateien zu erleichtern.

• Teams, um Chats, Kanäle und weitere Funktionen für die Zusammenarbeit zu integrieren.

• Planner, um Projektaufgaben zu aktualisieren und die Teamarbeit zu koordinieren.

4. Cloud-Dienste

SharePoint-Webparts können mit Microsoft Azure-Diensten kommunizieren, darunter Azure Blob Storage, Azure Functions und Azure SQL Database. Darüber hinaus können sie über Power BI-Berichte und -Dashboards berichten.

5. ERP/CRM

Die SharePoint-Webparts können Daten aus Systemen wie Microsoft Dynamics 365 und Salesforce abrufen. Informationen zu Kunden, Verkäufen und Supportaktivitäten sind somit im Intranet einsehbar und unterstützen die Arbeit der Nutzer.

Beispielsweise kann das Vertriebsteam die neuesten Kundenkommunikationen des Supportteams einsehen und wertvolle Erkenntnisse für die Geschäftsverhandlungen gewinnen. Ebenso kann das Supportteam auf Verkaufsdetails zugreifen, um Kundenprobleme zu analysieren und Lösungen zur Behebung vorzuschlagen.

6. Soziale Medien und andere Kommunikationskanäle

Webparts können mit den sozialen Profilen des Unternehmens, z. B. LinkedIn- oder Twitter-Profilen, integriert werden, um die neuesten im Intranet veröffentlichten Beiträge anzuzeigen oder die wichtigsten Inhalte für das Unternehmen hervorzuheben.

Webpart “Beiträge aus den sozialen Medien” von intranet.ai

Neben den sozialen Medien können auch Inhalte im RSS-Format, wie z. B. Nachrichten aus einem Online-Fachmagazin, in SharePoint importiert werden.

Webpart “RSS-Feed” von intranet.ai

SharePoint API und Microsoft Graph API: gibt es eine Beziehung?

Microsoft Graph ist eine Entwicklungsplattform, die einen einheitlichen Zugriffspunkt für Daten und Dienste von Microsoft 365 bietet, einschließlich Azure Active Directory, Outlook, OneDrive, Teams, Excel, Planner und SharePoint.

Sie ermöglicht den Zugriff auf die verschiedenen Microsoft-Dienste über eine einzige Schnittstelle, was die Entwicklung und Verwaltung von Anwendungen für Entwickler erheblich vereinfacht.

Graph unterstützt außerdem eine breite Palette von Operationen, darunter:

• Verwaltung von E-Mails und Kalendern in Outlook

• Interaktion mit Dateien und Dokumenten in OneDrive

• Zusammenarbeit und Kommunikation in Microsoft Teams

• Verwaltung von Benutzeridentitäten in Azure Active Directory

Es besteht also eine enge Verbindung zwischen den APIs der Microsoft 365-Produkte und den APIs von Microsoft Graph – und SharePoint bildet hier keine Ausnahme.

Die Integration der SharePoint-APIs in das Microsoft-Graph-Ökosystem ermöglicht es Entwicklern, auf Daten und Funktionen von SharePoint über dieselben Endpunkte und Authentifizierungstokens zuzugreifen, die auch für andere Microsoft-365-Dienste verwendet werden.

In der Praxis bieten die Microsoft-Graph-APIs eine einheitliche Schnittstelle zur Interaktion mit SharePoint-Ressourcen und erleichtern so die Interoperabilität zwischen SharePoint und anderen Microsoft-365-Diensten.

Mit Microsoft Graph ist es beispielsweise möglich, Informationen über eine SharePoint-Website abzurufen, auf in einer Bibliothek gespeicherte Dokumente zuzugreifen oder die Zugriffsberechtigungen für Unternehmensdateien zu verwalten – einfach über HTTP-Anfragen.

Das Ergebnis ist eine leistungsstarke und integrierte Plattform, die den Entwicklungsprozess vereinfacht und Unternehmen ermöglicht, das volle Potenzial ihrer Daten und Anwendungen auszuschöpfen.