SharePoint API und REST API: Was sind sie?

APIs sind die Mittel, über die verschiedene Systeme miteinander kommunizieren und Daten und Befehle austauschen. SharePoint, die wichtigste Plattform für die Zusammenarbeit in Microsoft 365, nutzt verschiedene Arten von APIs, um es den Nutzern zu ermöglichen, Webparts zu erstellen, anzupassen und zu pflegen, aus denen Websites wie das Unternehmensintranet bestehen. Unter diesen APIs spielen die REST-APIs aufgrund ihrer Flexibilität eine wichtige Rolle.

In diesem Artikel werden wir uns ansehen, was SharePoint-APIs sind und wofür sie verwendet werden, was REST-APIs auszeichnet und welche Funktionalitäten dank der Integration mit Microsoft Graph möglich sind.

SharePoint API: Wofür sind sie?

In der Programmierung sind APIs die Mittel, über die ein Programm mit einem anderen Programm oder einer externen Datenquelle kommunizieren kann. Im Fall von SharePoint ermöglichen APIs die Erstellung der Webteile einer Website, wie z. B. des Intranets.

Entwickler verwenden dann APIs, um SharePoint mit bestimmten Datenquellen zu verbinden, aus denen sie die Informationen ableiten, die benötigt werden, um Inhalte und Funktionen in den Webparts, aus denen eine Website besteht, anzubieten.

Wenn Informationen aus einer Datenquelle, die über eine API mit SharePoint verbunden ist, aktualisiert werden, ist es wichtig zu wissen, dass der Inhalt des entsprechenden Webparts automatisch und in Echtzeit aktualisiert wird.

SharePoint-APIs lassen sich in vier Hauptkategorien einteilen:

1. REST-APIs, die den Zugriff auf und die Manipulation von SharePoint-Ressourcen mit einfachen HTTP-Aufrufen ermöglichen. Im Allgemeinen führen RESTful-Anfragen CRUD-Vorgänge (Erstellen, Lesen, Aktualisieren, Löschen) für Elemente in SharePoint wie Listen, Dokumente und Websites aus.
   
   
2. Client-Side Object Model (CSOM): Der API-Typ, der eine Reihe von Bibliotheken bereitstellt, die in Sprachen wie JavaScript, .NET und Silverlight zur Interaktion mit SharePoint verwendet werden können. Diese APIs sind für die Durchführung clientseitiger Vorgänge nützlich, da sie die Ausführung von Code direkt im Browser des Benutzers beinhalten.
   
   
3. JavaScript Object Model (JOM): eine API-Kategorie, die CSOM ähnelt, aber spezifisch für JavaScript ist. Es wird daher häufig zur Erstellung der dynamischen Schnittstellen von SharePoint-Webparts verwendet.
   
   
4. SOAP Web Services: Diese APIs sind zwar weniger verbreitet als die anderen, ermöglichen aber die Kommunikation mit SharePoint über XML-basierte Protokolle.
   
   

Die SharePoint-APIs ermöglichen es, Webparts mit einer Vielzahl von Datenquellen zu verbinden, darunter externe Datenbanken (z. B. SQL Server), Cloud-Dienste (z. B. Microsoft Azure), ERP/CRM-Systeme (z. B. Dynamics 365 und Salesforce) und eine Vielzahl anderer Dienste und Anwendungen.

Am Beispiel einer API-Verbindung mit einem SQL Server könnte ein Webpart die Liste der in der Datenbank gespeicherten Projekte anzeigen. Diese Integration ermöglicht es autorisierten Benutzern, die für sie interessanten Informationen direkt im SharePoint-Intranet anzuzeigen, ohne auf separate Systeme zugreifen oder Daten nach einer Aktualisierung manuell übertragen zu müssen.

Das ist es also, was SharePoint-APIs ausmacht: die Bausteine, die wir brauchen, um alle Webparts zu erstellen, anzupassen und zu pflegen, die die Funktionalität und den Inhalt jeder SharePoint-Website bereichern.

SharePoint REST API: Wofür sind sie?

Die REST-API, die für Representational State Transfer Application Programming Interfaces steht, ist eine Reihe von Architekturprinzipien für den Entwurf und die Entwicklung von Netzwerksystemen.

Der Schwerpunkt der REST-Architektur liegt auf dem Konzept der Ressourcen. Sie basiert auf einem Kommunikationsmodell, bei dem Clients Anfragen an Server senden, um Aktionen für bestimmte Ressourcen durchzuführen. Diese Anfragen erfolgen in der Regel in Form von HTTP-Methoden wie GET, POST, PUT, PATCH und DELETE, die jeweils verschiedenen Operationen an den Ressourcen entsprechen.

Im speziellen Fall von SharePoint können die Ressourcen, auf die die REST-API einwirkt, sein:

• Die Elemente einer Liste
• Die Dokumente einer Bibliothek
• Eine Website in ihrer Gesamtheit

Clients können dann HTTP-Anfragen senden, um Aktionen mit den Ressourcen durchzuführen, wie z. B. das Abrufen bestimmter Informationen oder das Vornehmen von Änderungen. Ein Beispiel wäre das Senden einer GET-Anforderung, um die Details eines Dokuments in einer SharePoint-Bibliothek abzurufen; ein zweites Beispiel wäre eine POST-Anforderung, die häufig verwendet wird, um Elemente zu einer Liste hinzuzufügen.

Diese Flexibilität macht die REST-API zu einem leistungsstarken Werkzeug für die Integration und Automatisierung von Interaktionen mit SharePoint, das es Entwicklern ermöglicht, Anwendungen zu erstellen, die sich problemlos mit den Daten und Funktionen der Plattform verbinden lassen.

Weitere Aspekte, die die SharePoint REST API charakterisieren, sind:

1. Benutzerfreundlichkeit, da sie die effiziente Arbeit mit strukturierten und unstrukturierten Daten ermöglicht.
2. Sicherheit, da die Authentifizierung über OAuth und Zugriffstoken erfolgt. Dies bedeutet, dass nur autorisierte Benutzer und Anwendungen mit den Ressourcen interagieren können.
3. Kontextunabhängigkeit, da REST-Anfragen von jeder Umgebung aus gestellt werden können, die HTTP-Aufrufe unterstützt, einschließlich Browsern und mobilen Anwendungen.
4. Skalierbarkeit, so dass eine große Anzahl gleichzeitiger Anfragen bearbeitet werden kann, ohne dass der Server überlastet wird.

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 sich SharePoint über APIs verbinden?

Dank seiner API kann SharePoint eine Verbindung zu einer Vielzahl von Datenquellen und Programmen herstellen, um die Funktionalität und den Inhalt von Websites wie dem Intranet zu bereichern.

Gerade im Fall des 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 dann strukturierte Daten wie Ankündigungen, Kontakte, Ereignisse und Aktivitäten verwalten. Sie erleichtern auch das Anzeigen und Bearbeiten von Inhalten in SharePoint-Repositories, wie Geschäftsdokumente oder Mediendateien.

2. Externe Datenbanken

Webparts stellen eine Verbindung zu SQL Server-Datenbanken her, so dass Intranetbenutzer direkt auf archivierte Informationen zugreifen können, ohne die Umgebung wechseln zu müssen. Darüber hinaus können Webparts über APIs auch mit Datenbankmanagementsystemen wie Oracle verbunden werden, um eine zentrale Ansicht der Unternehmensdaten zu ermöglichen.

3. Microsoft 365-Anwendungen

Informationen aus den anderen Produkten, die den digitalen Arbeitsplatz von Microsoft 365 ausmachen (zu dem SharePoint gehört), können über APIs in SharePoint-Webparts integriert werden. Zu diesen Produkten gehören:

• Outlook, um E-Mail, Kalender und Kontakte zu integrieren.
• OneDrive, zur Vereinfachung der Verwaltung von persönlichen und gemeinsamen Dateien.
• Teams zur Integration von Chat, Kanälen und anderen Funktionen für die Zusammenarbeit.
• Planner, um Projektaktivitäten 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. Außerdem können sie auf Power BI-Berichte und -Dashboards zugreifen.

5. ERP/CRM

Webparts können Daten aus Systemen wie Microsoft Dynamics 365 und Salesforce abrufen. Informationen über Kunden, Vertriebs- und Supportaktivitäten werden so im Intranet verfügbar und unterstützen die Arbeit der Anwender.

So kann das Vertriebsteam beispielsweise die vom Supportteam verwaltete Kundenkommunikation einsehen und nützliche Erkenntnisse für das Management von Verkaufsverhandlungen gewinnen. In ähnlicher Weise kann das Support-Team auf Vertriebsdetails zugreifen, um Kundenprobleme zu analysieren und maßgeschneiderte Lösungen vorzuschlagen.

6. Business Intelligence-Tools

Zusätzlich zu Power BI können SharePoint-Webparts über API mit Tableau und Qlik verbunden werden. Diese gehören zu den beliebtesten und am weitesten verbreiteten Tools in Unternehmen für die Datenanalyse, und die Integration mit SharePoint ermöglicht einen zentralen Zugriff auf Informationen im Intranet und damit optimierte Entscheidungsprozesse.

7. Soziale Medien und andere Kommunikationskanäle

Die Webparts können mit den sozialen Profilen des Unternehmens, z.B. von LinkedIn oder Twitter, integriert werden, um die neuesten veröffentlichten Beiträge im Intranet anzuzeigen oder die wichtigsten Inhalte für das Unternehmen hervorzuheben. Neben den sozialen Medien können auch Inhalte im RSS-Format (z.B. Nachrichten aus einem Online-Fachmagazin) in SharePoint importiert werden.

Bei intranet.ai haben wir auf dieser Nutzung der SharePoint-API aufgebaut, um die Webparts "Beiträge aus den sozialen Medien" und "RSS-Feeds" zu erstellen, mit denen unsere Kunden den Inhalt des von uns gemeinsam aufgebauten Intranets einfach anreichern können.

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

Microsoft Graph ist eine Entwicklerplattform, die ein einheitliches Gateway für den Zugriff auf Microsoft 365-Daten und -Dienste bietet, darunter Azure Active Directory, Outlook, OneDrive, Teams, Excel, Planner und SharePoint.

Sie ermöglicht somit den Zugriff auf die zahlreichen Dienste von Microsoft von einem einzigen Einstiegspunkt aus, was die Anwendungsentwicklung und -verwaltung für Entwickler erheblich vereinfacht. Graph unterstützt auch eine breite Palette von Operationen, darunter:

• interaktion mit Dateien und Dokumenten in OneDrive
• mail- und Kalenderverwaltung in Outlook
• zusammenarbeit und Kommunikation in Microsoft Teams
• verwaltung von Benutzeridentitäten in Azure Active Directory

Es besteht also eine enge Beziehung zwischen Microsoft 365 Produkt-APIs und Microsoft Graph-APIs, und SharePoint ist da keine Ausnahme.

Die Integration der SharePoint-APIs in das Microsoft Graph-Ökosystem ermöglicht Entwicklern den Zugriff auf SharePoint-Daten und -Funktionen über dieselben Endpunkte und Authentifizierungstoken, die für andere Microsoft 365-Dienste verwendet werden. In der Praxis bieten die Microsoft Graph-APIs eineeinheitliche Schnittstelle für die Interaktion mit SharePoint-Ressourcen und erleichtern die Interoperabilität zwischen SharePoint und anderen Microsoft 365-Diensten.

Mit Microsoft Graph ist es beispielsweise möglich, Informationen auf einer SharePoint-Website abzurufen, auf in einer Bibliothek gespeicherte Dokumente zuzugreifen oder Zugriffsberechtigungen auf Unternehmensdateien zu verwalten. Und das auf einfache Art und Weise über HTTP-Aufrufe.

Das Ergebnis ist eine robuste und integrierte Plattform, die den Entwicklungsprozess vereinfacht und Unternehmen in die Lage versetzt, das Potenzial ihrer Daten und Anwendungen voll auszuschöpfen.

Was sind die SharePoint APIs und wofür werden sie verwendet?

Die SharePoint APIs sind Sammlungen von Definitionen und Protokollen, die die Kommunikation zwischen SharePoint und anderen Anwendungen oder externen Datenquellen ermöglichen. Diese APIs ermöglichen es, Webparts zu erstellen, anzupassen und zu pflegen, die Websites wie das Unternehmensintranet ausmachen und eine automatische Integration und Aktualisierung der Inhalte gewährleisten.

Was sind die SharePoint REST APIs und wofür werden sie verwendet?

Die SharePoint REST APIs sind eine Reihe von Architekturprinzipien zur Gestaltung und Entwicklung von Netzwerksystemen. Sie ermöglichen den Zugriff auf und die Manipulation von SharePoint-Ressourcen über einfache HTTP-Anfragen, wobei CRUD-Operationen (Create, Read, Update, Delete) auf Elemente wie Listen, Dokumente und Websites ausgeführt werden.

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

APIs sind Sammlungen von Definitionen und Protokollen zur Kommunikation zwischen verschiedenen Softwareanwendungen, während REST APIs eine Art von APIs sind, die den Architekturprinzipien von REST (Representational State Transfer) folgen. REST APIs verwenden HTTP-Methoden, um Operationen auf Ressourcen auszuführen, die durch eindeutige URLs identifiziert werden. Nicht alle APIs sind REST APIs, aber alle REST APIs sind APIs.

Mit welchen Datenquellen kann SharePoint über APIs verbunden werden?

SharePoint kann über APIs mit einer Vielzahl von Datenquellen verbunden werden, darunter SharePoint-Listen und -Bibliotheken, externe Datenbanken (wie SQL Server und Oracle), Microsoft 365-Anwendungen (Outlook, OneDrive, Teams, Planner), Cloud-Dienste (Microsoft Azure, Power BI), ERP/CRM-Systeme (Dynamics 365, Salesforce), Business Intelligence-Tools (Tableau, Qlik) und Kommunikationskanäle wie soziale Medien und RSS-Feeds.

Gibt es eine Beziehung zwischen den SharePoint APIs und Microsoft Graph API?

Ja, Microsoft Graph ist eine Plattform, die einen einheitlichen Gateway für den Zugriff auf Daten und Dienste von Microsoft 365, einschließlich SharePoint, bietet. Die Integration der SharePoint APIs in Microsoft Graph ermöglicht es Entwicklern, auf die Funktionen von SharePoint über dieselben Endpunkte und Authentifizierungstoken zuzugreifen, die auch für andere Microsoft 365-Dienste verwendet werden, was die Interoperabilität zwischen SharePoint und anderen Microsoft-Diensten vereinfacht.