In dieser Schnellanleitung erfahren Sie, wie Sie OAuth für Ihre App einrichten (inkl. eines Node.js-App-Beispiels).
Mit * markierte Felder sind Pflichtfelder.
Parameter | Beschreibung | Beispiel |
---|---|---|
client_id * | Die Client-ID identifiziert Ihre App. Sie finden sie auf der Einstellungsseite Ihrer App. | 7fff1e36-2d40-4ae1-bbb1-5266d59564fb |
scope * | Die Bereiche, die Ihre Anwendung anfordert, getrennt durch URL-codierte Leerzeichen%20 . | oauth%20crm.objects.contacts.read |
redirect_uri * | Die URL, zu der der Benutzer weitergeleitet wird, nachdem er Ihre App für die angeforderten Bereiche autorisiert hat. Für Produktionsanwendungen ist https erforderlich. | https://www.example.com/auth-callback |
optional_scope | Die Bereiche, die für Ihre App optional sind und verworfen werden, wenn das ausgewählte HubSpot-Portal keinen Zugriff auf diese Produkte hat | automation |
state | Ein eindeutiger Zeichenfolgenwert, der zur Aufrechterhaltung des Status des Benutzers verwendet werden kann, wenn er zurück zu Ihrer App weitergeleitet wird. | WeHH_yy2irpl8UYAvv-my |
userA.integration.com
und userB.integration.com
). Verwenden Sie dazu den state
-Parameter, um weitere Informationen zum Benutzerstatus zu codieren:
1. Generieren und speichern Sie einen Nonce-Wert für den state-Parameter.
2. Speichern Sie den Status des Benutzers in einem lokalen Datenspeicher mit dem Nonce-Wert als dessen Schlüssel.
3. Schließen Sie den Nonce-Wert als state-Parameter in der Autorisierungs-URL ein.
4. Wenn sich der Benutzer authentifiziert und zu Ihrer Weiterleitungs-URL weitergeleitet wird, validieren Sie den state-Parameter und verwenden Sie ihn als Schlüssel, um den gespeicherten Benutzerstatus abzurufen.
5. Leiten Sie den Benutzer von dort aus nach Bedarf weiter (z. B. durch erneutes Weiterleiten zu einer benutzerspezifischen URL).
GET
-Anfrage an den in Ihrer Authentifizierungs-URL angegebenen Weiterleitungs-URI. Falls keine Fehler auftreten und der Benutzer die Zugriffsanfrage akzeptiert, wird die Anfrage mit einem angehängten code
-Abfrageparameter an den Weiterleitungs-URI zurückgegeben. Gewährt der Benutzer keinen Zugriff, wird keine Anfrage gesendet.
Beispiel:
POST
-Anfrage mit den unten aufgeführten Werten an https://api.hubapi.com/oauth/v1/token
gesendet wird. Weitere Informationen zu diesem Schritt erhalten Sie in diesem Referenzdokument.
Parameter | Beschreibung | Beispiel |
---|---|---|
grant_type | Muss sein authorization_code | authorization_code |
client_id | Die Client-ID Ihrer App | 7fff1e36-2d40-4ae1-bbb1-5266d59564fb |
client_secret | Das Client-Geheimnis Ihrer App | 7c3ce02c-0f0c-4c9f-9700-92440c9bdf2d |
redirect_uri | Die Weiterleitungs-URI vom Autorisieren Ihrer App durch den Benutzer | https://www.example.com/auth-callback |
code | Der Autorisierungscode, der vom OAuth 2.0-Server empfangen wurde | 5771f587-2fe7-40e8-8784-042fb4bc2c31 |
expires_in
-Feld der Antwort angegeben ist. Aktuell sind dies 30 Minuten. Details zum Erhalt eines neuen Zugriffs Token finden Sie weiter unten im Abschnitt Aktualisieren von OAuth-Token.Authorization
-HTTP-Header bereit. Spezifische Details dazu finden Sie im Referenzdokument.
Beispiel:
crm.objects.contacts.read
-Bereich autorisiert, kann das resultierende Zugriffstoken alle Kontakte im Account anzeigen und nicht nur die, die dem autorisierenden Benutzer gehören.expires_in
-Feld angegeben, wenn ein Autorisierungscode gegen ein Zugriffstoken getauscht wird.
Ihre App kann das empfangene Aktualisierungstoken gegen ein neues Zugriffstoken tauschen, indem eine im URL-Format codierte POST
-Anfrage mit den unten aufgeführten Werten an https://api.hubapi.com/oauth/v1/token
gesendet wird. Weitere Informationen zu diesem Schritt finden Sie in der Referenzdokumentation.
| Parameter | Beschreibung | Beispiel |
| --------------- | ------------------------------------------------------------------------------------------------- | --------------------------------------- | ----- |
| grant_type
| Muss refresh_token
| refresh_token
| sein. |
| client_id
| Die Client-ID Ihrer App | 7fff1e36-2d40-4ae1-bbb1-5266d59564fb
|
| client_secret
| Das Client-Geheimnis Ihrer App | 7c3ce02c-0f0c-4c9f-9700-92440c9bdf2d
|
| redirect_uri
| Die Weiterleitungs-URI vom Autorisieren Ihrer App durch den Benutzer | https://www.example.com/auth-callback
|
| refresh_token
| Das Aktualisierungstoken, dass bei der Autorisierung Ihrer App durch den Benutzer empfangen wurde | b9443019-30fe-4df1-a67e-3d75cbd0f726
|
Beispiel: