Découvrez comment configurer OAuth pour votre application à l’aide de ce guide de démarrage rapide et de cet exemple d’application Node.js.
Les champs marqués par * sont obligatoires.
Paramètre | Description | Exemple |
---|---|---|
client_id * | L’ID de client identifie votre application. Trouvez-le sur la page des paramètres de votre application. | 7fff1e36-2d40-4ae1-bbb1-5266d59564fb |
scope * | Les périmètres d’accès demandés par votre application, séparés par des espaces en format URL-encoded (%20 ). | oauth%20crm.objects.contacts.read |
redirect_uri * | L’URL vers laquelle l’utilisateur sera redirigé après avoir autorisé votre application pour les périmètres d’accès demandés. Pour les applications de production, https est obligatoire. | https://www.example.com/auth-callback |
optional_scope | Les périmètres d’accès qui sont facultatifs pour votre application seront abandonnées si le portail HubSpot sélectionné n’a pas accès à ces produits. | automation |
state | Une valeur de chaîne unique pouvant être utilisée pour maintenir l’état de l’utilisateur lorsqu’il est redirigé vers votre application. | WeHH_yy2irpl8UYAvv-my |
userA.integration.com
et userB.integration.com
). Pour ce faire, utilisez le paramètre state
pour encoder plus d’informations sur le statut de l’utilisateur :
1. Générez et stockez une valeur nonce pour le paramètre de statut.
2. Stockez le statut de l’utilisateur dans une banque de données locale en utilisant le nonce comme clé.
3. Incluez la valeur nonce comme paramètre de statut dans l’URL d’autorisation.
4. Lorsque l’utilisateur s’authentifie et est redirigé vers l’URL de redirection, validez le paramètre de statut et utilisez-le comme clé pour récupérer le statut de l’utilisateur stocké.
5. À partir de là, redirigez l’utilisateur au besoin (par exemple, rediriger à nouveau vers une URL spécifique à l’utilisateur).
GET
à l’URI de redirection indiquée dans votre URL d’authentification. S’il n’y a aucun problème et que l’utilisateur a approuvé la demande d’accès, la requête à l’URI de redirection aura un retour avec le paramètre de requête code
joint. Si l’utilisateur n’autorise pas l’accès, aucune requête ne sera envoyée.
Exemple :
POST
en format form-urlencoded à https://api.hubapi.com/oauth/v1/token
avec les valeurs affichées ci-dessous. Pour plus d’informations sur cette étape, consultez la documentation de référence.
Paramètre | Description | Exemple |
---|---|---|
grant_type | Doit correspondre à authorization_code | authorization_code |
client_id | ID de client de votre application | 7fff1e36-2d40-4ae1-bbb1-5266d59564fb |
client_secret | Secret de client de votre application | 7c3ce02c-0f0c-4c9f-9700-92440c9bdf2d |
redirect_uri | URI de redirection lorsque l’utilisateur autorise votre application | https://www.example.com/auth-callback |
code | Le code d’autorisation reçu de la part du serveur OAuth 2.0 | 5771f587-2fe7-40e8-8784-042fb4bc2c31 |
expires_in
de la réponse (actuellement 30 minutes). Pour plus de détails sur l’obtention d’un nouveau jeton d’accès, consultez la section Actualiser les jetons OAuth ci-dessous.Authorization
. Des détails spécifiques sont disponibles dans la documentation de référence.
Exemple :
crm.objects.contacts.read
, le jeton d’accès résultant peut afficher tous les contacts du compte et pas seulement ceux détenus par l’utilisateur autorisant.expires_in
lorsqu’un code d’autorisation est échangé contre un jeton d’accès.
Votre application peut échanger le jeton d’actualisation reçu contre un nouveau jeton d’accès en envoyant une requête POST
en format form-urlencoded à https://api.hubapi.com/oauth/v1/token
avec les valeurs ci-dessous. Pour plus d’informations sur cette étape, consultez la documentation de référence.
Paramètre | Description | Exemple |
---|---|---|
grant_type | Doit correspondre à refresh_token | refresh_token |
client_id | ID de client de votre application | 7fff1e36-2d40-4ae1-bbb1-5266d59564fb |
client_secret | Secret de client de votre application | 7c3ce02c-0f0c-4c9f-9700-92440c9bdf2d |
redirect_uri | URI de redirection lorsque l’utilisateur autorise votre application | https://www.example.com/auth-callback |
refresh_token | Le jeton d’actualisation reçu lorsque l’utilisateur autorise votre application | b9443019-30fe-4df1-a67e-3d75cbd0f726 |