Bevorstehende Einstellung: API-Schlüssel

[MiaSrebrnjak]

Angekündigt: 1. Juni 2022 (Link zur Ankündigung in HubSpot Developer Changelog)

Live: 30. November 2022 (seit dem 15. Juli 2022 ist es nicht mehr möglich, neue API-Schlüssel zu erstellen)

Welches Feature wird entfernt? 

API-Schlüssel waren eine von drei Authentifizierungsmethoden, die von HubSpot-APIs unterstützt wurden. Im Rahmen laufender Initiativen, mit denen wir die Daten unserer Kundschaft noch effektiver schützen möchten, werden API-Schlüssel jedoch eingestellt.

Statt der API-Keys müssen die Integrationen jetzt private Apps nutzen. Private Apps sind im Vergleich zu den API-Schlüsseln sicherer und erlauben mehr Kontrolle über eure Integrationen und Account-Daten.

Was dies für Entwickler*innen bedeutet

Mit der Einführung von Private Apps müssen Benutzer*innen, die bisher auf HubSpot entwickelt und API-Schlüssel verwendet haben, bestehende Integrationen von der API-Schlüssel-Authentifizierung zu Private Apps migrieren. Eine Anleitung für die Migration bestehender Integrationen findest du hier.

Warum wird dieses Feature entfernt?

Mit Private Apps kannst du für jede Integration ein eigenes statisches Zugriffstoken einrichten. Das Scoping funktionirt bei App-Zugriffstoken  wie bei OAuth-Zugriffstoken, sodass du den Zugriff jeder Integration auf euer HubSpot-Account steuern kannst.

Private Apps funktionieren ähnlich wie API-Schlüssel-Integrationen, du verwendest aber anstatt eines API-Schlüssels im Autorisierungsabfrageparameter ein statisches Zugriffstoken im Autorisierungs-HTTP-Header. Abgesehen von der Aktualisierung der Authentifizierungsmethode sollten keine weiteren Änderungen erforderlich sein.

Wenn eure Integration von mehreren HubSpot-Accounts verwendet werden soll, dann muss die Integration zu einer öffentlichen App mit OAuth 2.0 aktualisiert werden. Private Apps sollen nicht für Multi-Account-Apps verwendet werden. OAuth 2.0 bietet dieselben Sicherheitsfunktionen wie Private Apps, sie ermöglicht aber eine viel bessere Erfahrung für HubSpot-Benutzer*innen, da sie ihren HubSpot-Account schnell und ohne zusätzlichen Code mit eurer App verbinden können.

Wann wird dieses Feature eingestellt?

Ab dem 30. November 2022 werden unsere Kund*innen keinen Zugang mehr zu API-Schlüsseln haben und können somit auch keine API-Schlüssel mehr als Authentifizierungsmethode für HubSpot-APIs verwenden.

Seit dem 15. Juli 2022 können keine neuen API-Schlüssel mehr erstellt werden. Bestehende API-Schlüssel funktionieren noch bis zum 30. November. Accounts, die aber bis zum 15. Juli 2022 noch keinen API-Schlüssel erstellt haben, können keine neuen API-Schlüssel mehr erstellen. API-Aufrufe, die mit API-Schlüsseln am oder nach dem 30. November 2022 erfolgen, geben einen 401-Fehler zurück.

Um Private Apps zu nutzen, lies bitte zuerst die Dokumentation zu Private Apps.

API-Schlüssel in Entwickler-Accounts (mit denen öffentliche Apps konfiguriert werden können) stehen auch nach dem 30. November 2022 weiterhin zur Verfügung und sind vom API-Schlüssel-Sunset nicht betroffen.

Der oben verlinkte Migrationsleitfaden ist die beste Ressource bei Fragen zum API-Schlüssel-Sunset. Wenn du eine Frage hast, die dort nicht beantwortet wurde, wende dich bitte an unseren Support.