Bitte beachten: Ab dem 30. November 2022 können HubSpot-API-Schlüssel nicht mehr als Authentifizierungsmethode für den Zugriff auf HubSpot-APIs verwendet werden. Darüber hinaus können ab dem 15. Juli 2022 Accounts ohne bereits generierten HubSpot-API-Schlüssel keinen API-Schlüssel mehr erstellen.
Stattdessen müssen Sie das Zugriffstoken einer privaten App oder OAuth verwenden, um API-Aufrufe zu authentifizieren. Erfahren Sie mehr über diese Änderung und wie Sie eine API-Schlüssel-Integration migrieren, um stattdessen eine private App zu verwenden.
Authentifizierungsmethoden in HubSpot
Es gibt drei Möglichkeiten, Aufrufe an die HubSpot-APIs zu authentifizieren: OAuth, Zugriffstoken von privaten Apps und API-Schlüssel.
Wenn Sie eine Integration erstellen, beachten Sie Folgendes:
- Während die meisten Endpunkte die Authentifizierung über API-Schlüssel unterstützen, bieten API-Schlüssel sowohl Lese- als auch Schreibzugriff auf alle Ihre HubSpot CRM-Daten. Dies kann ein Sicherheitsrisiko darstellen, wenn Ihr API-Schlüssel kompromittiert wird. Um bewährte Methoden zu befolgen, wird empfohlen, das Zugriffstoken einer privaten App oder OAuth zu verwenden. Mit beiden Methoden können Sie die Daten begrenzen, die Ihre Integration in Ihrem Account anfragen oder ändern kann.
- Integrationen, die für die Verwendung von mehreren Kunden oder als Listing im App Marketplace gedacht sind, müssen als App erstellt werden, die das OAuth-Protokoll von HubSpot verwendet.
Im Folgenden erfahren Sie mehr über die einzelnen Methoden, einschließlich, wie Sie sie in Ihrem Code für die Autorisierung berücksichtigen können.
Der einzige Unterschied zwischen API-Schlüsseln in Standard-HubSpot-Accounts und Entwickler-Accounts ist der Account-Typ, auf den der Schlüssel Zugriff gewährt. Erfahren Sie mehr über die Account-Typen von HubSpot.
Um eine Anfrage mit OAuth durchzuführen, fügen Sie das OAuth-Zugriffstoken in den Autorisierungsheader ein:
Um eine Anfrage über das Zugriffstoken einer privaten App durchzuführen, fügen Sie ähnlich wie bei OAuth das Token in den Autorisierungsheader ein:
Um eine Anfrage mithilfe eines API-Tokens durchzuführen, fügen Sie dem Schlüssel einen hapikey= -Abfrageparameter hinzu:
Wenn Sie in HubSpot entwickeln, ziehen Sie es möglicherweise vor, in Ihrer eigenen HubSpot-Testumgebung zu arbeiten, bevor Sie in einem Produktions-Account arbeiten. Dazu können Sie einen Entwickler-Account erstellen. Mit einem Entwickler-Account können Sie eine App erstellen und sie mithilfe von OAuth authentifizieren. Jeder Account enthält einen Entwickler-Account-API-Schlüssel. Außerdem können Sie einen Test-Produktions-Account erstellen, der über seinen eigenen API-Schlüssel verfügt.