Empfohlene Ressourcen
- Die OAuth-Schnellanleitung ermöglicht Ihnen mithilfe einer Arbeitsbeispiel-App einen schnellen Einstieg.
- Dieses HubSpot Academy-Tutorial bietet eine schnelle Einführung in die Verwendung von OAuth mit HubSpot, einschließlich einer ausführlichen Darstellung des HubSpot-OAuth-Prozesses und der Aktualisierung eines Zugriffstokens.
OAuth-Authentifizierung einrichten
So richten Sie die OAuth-Authentifizierung für Ihre App ein:- Zuerst müssen Sie eine App erstellen in einem HubSpot-Entwickler-Account. Nach dem Erstellen der App finden Sie die Client-ID und das Client-Geheimnis der App auf der Seite zur Authentifizierung Ihrer App-Einstellungen.
- Verwenden Sie die Client-ID und das Client-Geheimnis zusammen mit den unten beschriebenen Abfrageparametern und Bereichen, um Ihre Autorisierungs-URL zu erstellen.
-
Leiten Sie Benutzer, die Ihre App installieren, zur Autorisierungs-URL weiter, wo ihnen ein Bildschirm angezeigt wird, auf dem sie ihren Account auswählen können und Zugriff auf Ihre Integration gewährt werden kann. Sie können die Autorisierungs-URL für einen bestimmten HubSpot-Account festlegen, indem Sie die Account-ID zwischen
/oauth/und/authorizehinzufügen, wie unten gezeigt. Nachdem Sie Zugriff gewährt haben, gelangen sie über eineredirect_url, der ein Code-Abfrageparameter angehängt ist, zurück zu Ihrer Anwendung. Sie verwenden diesen Code und das Client-Geheimnis, um ein access_token und refresh_token von HubSpot zu erhalten.- Beispiel-Autorisierungs-URLs
- Alle Accounts:
https://app.hubspot.com/oauth/authorize?client_id=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&scope=contacts%20automation&redirect_uri=https://www.example.com/ - Spezifischer Account (ID 123456):
https://app.hubspot.com/oauth/123456/authorize?client_id=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&scope=contacts%20automation&redirect_uri=https://www.example.com/
- Alle Accounts:
- Beispiel-Weiterleitungs-URL:
https://example.com/?code=xxxx - Beispielfehler:
https://www.example.com/?error=error_code&error_description=Human%20readable%20description%20of%20the%20error
- Beispiel-Autorisierungs-URLs
-
Verwenden Sie
access_token, um API-Aufrufe zu authentifizieren, die für diesen HubSpot-Account vorgenommen wurden. -
Nachdem das
access_tokenabgelaufen ist, verwenden Sie dasrefresh_token, mum ein neuesaccess_tokenzu generieren.
Abfrageparameter
Die folgenden Abfrageparameter sind erforderlich, wenn Sie eine Autorisierungs-URL für Ihre App erstellen:
Die folgenden Parameter sind optional:
Bereiche konfigurieren
OAuth erfordert, dass Sie Bereiche, oder Berechtigungen, für Ihre App festlegen. Jeder Bereich bietet Zugriff auf eine Reihe von HubSpot-API-Endpunkten und ermöglicht Benutzern, Ihrer App Zugriff auf bestimmte Tools in ihrem HubSpot-Account zu gewähren.
Der Zugriff auf bestimmte APIs oder Endpunkte hängt von der HubSpot-Account-Stufe ab. Wenn Ihre App mit mehreren Typen von HubSpot-Accounts arbeitet, können Sie den optional_scope-Parameter verwenden, um alle Stufen-Bereiche zu bierücksichtigen, mit denen Sie arbeiten. Auf diese Weise können Kunden, die kostenlose HubSpot-Accounts verwenden, weiterhin Ihre App autorisieren, selbst wenn sie nicht auf alle ihre Bereiche Zugriff haben. Ihre App muss auf alle Bereiche überprüfen, für die sie nicht autorisiert wird, und diese verarbeiten.
Eine vollständige Liste der Bereiche finden Sie hier.