HubSpot CMS-API: So wird sie richtig angebunden

In vergangenen Blogartikeln wurden die Themen CMS, Hubspot-Websites und API betrachtet. Mit der Hubspot-CMS-API können die diversen Funktionalitäten des CMS in eine Hubspot-Integration eingebunden werden, was Entwicklern vielfältige Möglichkeiten bietet, unterschiedliche Anforderungen und Wünsche an ein CMS-Projekt umzusetzen.

Was ist das HubSpot CMS?

Als kurze Auffrischung zum Thema:

Das CMS dient zur Erstellung von Webseiten und ist speziell für die Integration mit verschiedenen HubSpot-Funktionen konzipiert, wie beispielsweise Marketing-, Vertriebs- und Service-Tools. Diese Funktionen können unter anderem über die CMS-API, die Anwendungsschnittstelle zur Anbindung des CMS- bzw. Content Hubs, genutzt werden. Dadurch können komplexe Anforderungen an ein CMS-Projekt effizient durch HubSpot-Integrationen gelöst werden.

Was genau ist die CMS-API?

Die CMS-API ist die Schnittstelle zum HubSpot-CMS und dessen vielfältigen Funktionalitäten, wie HubDB, Templates, Module und Blogs. Wer sich einen Überblick verschaffen möchte, kann unter HubSpot API-Dokumentation im Reiter "CMS" die verschiedenen Endpunkte der API einsehen.

Erfahrene HubSpot-Nutzer wissen, dass viele dieser Funktionen auch in der HubSpot-UI, z.B. durch die Drag-and-Drop-Website-Erstellung, verfügbar sind. Die Nutzung der API ist daher nicht zwingend erforderlich, bietet jedoch erweiterte Funktionen, die in Kombination mit einer HubSpot-Integration genutzt werden können. Aufgrund der umfassenden Möglichkeiten der CMS-API wäre eine detaillierte Erklärung aller Funktionen hier nicht sinnvoll. Daher folgt am Ende dieses Beitrags eine kurze Erläuterung der Anbindung anhand eines konkreten Beispiels, um einen Überblick zu bieten.

Wie verwende ich die HubSpot CMS-API?

Die Grundlage der API-Nutzung ist eine private oder öffentliche App in HubSpot. Ein Entwickler integriert die Funktionen der CMS-API je nach Bedarf in diese App. Eine solche "CMS-API-App" erweitert die Funktionalität von HubSpot um die ausgewählten Funktionen. Nach der Installation der App im HubSpot-Portal stehen die integrierten Funktionen zur Verfügung.

Was ist zu beachten, wenn ich die CMS-API nutzen will?

Grundsätzlich lassen sich einige Empfehlungen bei der Entwicklung mit der HubSpot-API aussprechen, die nicht nur für die CMS-API, sondern für jede Integration mit HubSpot gelten.

Zunächst sollte man sicherstellen, dass man Zugriff auf die HubSpot-API hat. Dies ist entweder über eine öffentliche App, wofür ein Entwicklerkonto benötigt wird, oder über eine private App möglich. Dabei ist darauf zu achten, dass die korrekten App-Scopes für die gewünschten CMS-Funktionen in den App-Einstellungen festgelegt sind.

Durch diese Apps erhält man dann einen Zugriffsschlüssel (Access Token) für die HubSpot-API, der die Nutzung dieser in einer eigenen Anwendung ermöglicht. Es wird dringend empfohlen, vor jeglicher Nutzung die vorhandene HubSpot-Dokumentation zu lesen. Anschließend kann man entscheiden, welche Endpunkte der API (wie HubDB, Blogs etc.) genutzt werden sollen bzw. welche für das Projekt relevant sind.

Die entwickelte Integration kann dann Daten gemäß den festgelegten Anforderungen verarbeiten und beispielsweise auf einer Website darstellen.

Wie jeder, der bereits programmiert oder eine Anwendung entwickelt hat, weiß, sollte man stets eine spezifische Fehlerbehandlung in die Anwendung einbauen und Sicherheits-Best-Practices einhalten. Dies gewährleistet die Integrität der Daten und die Sicherheit der Benutzer.

Konkretes Beispiel: HubSpot CMS API - HubDB

Ohne dabei zu sehr auf technische Details einzugehen, kann die Anbindung der CMS-API anhand eines Beispiels verdeutlicht werden.

Stellen Sie sich vor, Sie haben eine externe Datenquelle, die Daten im XML-Format bereitstellt. Eine von Ihnen entwickelte Anwendung liest die Elemente der XML-Datei aus und soll diese Daten nun in eine HubDB innerhalb von HubSpot schreiben. Von dort aus werden sie auf einer im CMS gehosteten Website eingebunden. Ein solches Szenario lässt sich über eine CMS-API-Integration einfach umsetzen.

Zunächst würde man im HubSpot-UI eine App erstellen, beispielsweise eine private App im eigenen Account, und die korrekten Scopes, in diesem Fall "Hub DB", auswählen. Der generierte Zugriffstoken, der in den App-Einstellungen in HubSpot angezeigt wird, ermöglicht den Zugriff auf die HubSpot-CMS-API und spezifisch auf die HubDB-Funktionen in der Anwendung.

Die Dokumentation unter HubSpot CMS-API gibt Aufschluss darüber, welche Funktionen die CMS-API in Bezug auf HubDBs zur Verfügung stellt. Der Endpunkt "Aktualisiert eine vorhandene Zeile" ermöglicht es beispielsweise, die aus der XML-Datei ausgelesenen Daten in die jeweiligen Spalten der HubDB zu schreiben.

Für das Erstellen der Website würde man dann die entsprechenden Endpunkte wählen, um die Daten automatisiert und dynamisch aus der HubDB auszulesen und in die Website einzubinden. Auf diese Weise kann die eingangs beschriebene Anforderung effizient umgesetzt werden.

HubSpot CMS-API - Fazit

Die HubSpot-CMS-API bietet ein breites Spektrum an Funktionen, das auf den ersten Blick überwältigend erscheinen mag. Dank der ausführlichen Dokumentation und Tutorials, die HubSpot zur Verfügung stellt, können diese vielfältigen Möglichkeiten jedoch effizient genutzt werden, um das volle Potenzial des HubSpot Content Hubs auszuschöpfen.

Bei Bedarf stehen zudem professionelle Partner wie CIXON zur Verfügung, die bei der Integration und Nutzung der API unterstützend zur Seite stehen.

Wenn du mehr über die HubSpot APIs erfahren willst, dann kannst du jetzt hier unseren kostenfreien Newsletter abonnieren.