`API de HubSpot | Règles d'utilisation`

HubSpot suit attentivement l’utilisation de ses API publiques pour assurer une expérience de qualité pour chaque utilisateur. Tous les développeurs d’applications et d’intégrations doivent respecter la Politique d’utilisation acceptable de HubSpot et les Conditions générales relatives aux API. Bien que HubSpot se réserve le droit de modifier ou de désapprouver les API au fil du temps, les mises à jour seront toujours fournies à l’avance via le changelog des développeurs.

Authentification et sécurité

Pour une sécurité optimale, toutes les applications doivent utiliser directement le protocole OAuth de HubSpot ou le jeton d’accès de votre application si vous créez une application privée. Les applications sont chargées de stocker des données time-to-live (TTL) et d’actualiser les jetons d’accès des utilisateurs conformément à ce protocole. Lorsqu’un jeton d’accès est généré, il inclura un paramètre expires_in indiquant la durée durant laquelle il peut être utilisé pour effectuer des appels d’API avant l’actualisation. Les requêtes Unauthorized (401) ne sont pas un indicateur valide qu’un nouveau jeton d’accès doit être récupéré.

Vérification de l’utilisation des API

Applications privées

Pour afficher l’utilisation de l’API pour une application privée :

Dans votre compte HubSpot, cliquez sur l’icône Paramètres dans la barre de navigation principale.
Dans le menu latéral de gauche, accédez à Intégrations > Applications privées.
Cliquez sur le nom de l’application privée.
Sur la page de détails de l’application, cliquez sur l’onglet Journaux.
Passez en revue les appels d’API répertoriés dans le tableau. Vous pouvez également utiliser la barre de recherche, les filtres et les sélecteurs de dates pour affiner davantage les appels d’API affichés.

Découvrez-en davantage sur la vérification de l’utilisation de l’API dans les applications privées.

Applications publiques utilisant OAuth

Pour afficher l’utilisation de l’API pour une application publique utilisant OAuth :

Dans votre compte de développeur, accédez à Applications dans la barre de navigation.
Cliquez sur le nom de l’application.
Dans le menu latéral de gauche, accédez à Suivi.
Utilisez les onglets pour afficher les différents types de requêtes effectuées vers ou à partir de l’application. Lors de l’affichage de ces journaux, vous pouvez cliquer sur une requête individuelle pour afficher plus d’informations à son sujet.

Découvrez-en davantage sur le suivi de l’utilisation de l’API pour les applications publiques.

Limites de taux

Applications publiques

Pour les applications OAuth, chaque compte HubSpot qui installe votre application est limité à 110 requêtes toutes les 10 secondes. Cela exclut l’API de recherche, comme indiqué dans la section Autres limites ci-dessous. Les limites liées à l’augmentation de la limite d’API ne s’appliquent pas.

Applications privées

Le nombre d’appels que votre application privée peut effectuer dépend de l’abonnement de votre compte et de l’achat de l’augmentation de la limite d’API :

	Niveau de produit	Toutes les 10 secondes	Par jour
Applications privées	(Tout logiciel) Gratuit et Starter	100/application privée	250 000/compte
	(Tout logiciel) Pro	190/application privée	625 000/compte
	(Tout logiciel) Entreprise	190/application privée	1 000 000/compte
Applications privées avec augmentation de la limite d’API	(Tout logiciel) Gratuit, Starter, Pro et Entreprise	250/application privée	1 000 000/compte en plus de votre abonnement de base, pour chaque augmentation de la limite. Vous pouvez acheter un maximum de deux augmentations de limite d’API.

Remarque:

l’achat d’une augmentation de la limite d’API augmentera le nombre maximum de requêtes que vous pouvez effectuer sur l’API des associations à 1 000 000 requêtes quotidiennes et à 200 requêtes toutes les 10 secondes, mais ces limites ne peuvent pas être augmentées davantage avec un achat supplémentaire de limite d’API.

Autres limites

Vous pouvez créer jusqu’à 100 applications par compte de développeur.
Vous pouvez créer jusqu’à 20 applications privées par compte HubSpot.
Vous pouvez créer jusqu’à 1 000 abonnements de webhook par application.
Vous pouvez créer jusqu’à 25 paramètres d’extension de CRM par application.
Vous pouvez créer jusqu’à 750 types d’événements chronologiques par application.
Vous pouvez créer jusqu’à 500 propriétés par type d’événement chronologique.

Limites de requête

Gardez à l’esprit les limites générales suivantes lorsque vous effectuez des requêtes aux points de terminaison d’API de HubSpot. Certaines API peuvent également avoir leurs propres limites, plus spécifiques, qui seront répertoriées sur la page de référence des API sous Limites.

Les points de terminaison de l’API de recherche sont limités à 5 requêtes par seconde par jeton d’authentification et 200 fiches d’informations par requête de page. Découvrez-en davantage sur les limites de recherche.
Les requêtes d’API qui sont exemptées des limites quotidiennes ou secondaires ne seront pas enregistrées dans HubSpot. Si vous souhaitez enregistrer ces requêtes exemptées, vous devez les enregistrer en externe.
Les requêtes de lot vers les points de terminaison des objets CRM sont limitées à 100 fiches d’informations par requête. Par exemple, vous ne pouvez pas lire plus de 100 contacts par requête.

Limites de service

Découvrez-en davantage sur les limites de service et les tarifs ici.

Réponses d’erreur

Toute application ou intégration dépassant ses limites de taux recevra une réponse d’erreur 429 pour tous les appels d’API ultérieurs. Les requêtes résultant d’une réponse d’erreur ne doivent pas dépasser 5 % de vos requêtes quotidiennes. Si vous prévoyez de répertorier votre application dans le marketplace des applications de HubSpot, celle-ci doit rester sous cette limite de 5 % pour être certifiée. La réponse 429 sera au format suivant :

//Example
{
  "status": "error",
  "message": "You have reached your daily limit.",
  "errorType": "RATE_LIMIT",
  "correlationId": "c033cdaa-2c40-4a64-ae48-b4cec88dad24",
  "policyName": "DAILY",
  "requestId": "3d3e35b7-0dae-4b9f-a6e3-9c230cbcf8dd"
}

message et policyName indiqueront la limite que vous avez atteinte (quotidienne ou par seconde). La limite quotidienne se réinitialise à minuit selon votre fuseau horaire. Le tableau suivant détaille les en-têtes de limite de débit inclus dans la réponse de chaque appel d’API formulé à HubSpot, sous réserve des exceptions répertoriées sous le tableau.

En-tête	Description
`X-HubSpot-RateLimit-Daily`	Le nombre d’appels d’API autorisés par jour. Notez que cet en-tête n’est pas inclus dans la réponse aux appels d’API autorisés utilisant OAuth.
`X-HubSpot-RateLimit-Daily-Remaining`	Le nombre d’appels d’API encore autorisés pour le jour en cours. Notez que cet en-tête n’est pas inclus dans la réponse aux appels d’API autorisés utilisant OAuth.
`X-HubSpot-RateLimit-Interval-Milliseconds`	La fenêtre de temps à laquelle s’appliquent les en-têtes `X-HubSpot-RateLimit-Max` et `X-HubSpot-RateLimit-Remaining`. Par exemple : une valeur de 10 000 serait une fenêtre de 10 secondes.
`X-HubSpot-RateLimit-Max`	Le nombre de requêtes autorisées dans la fenêtre indiquée dans `X-HubSpot-RateLimit-Interval-Milliseconds`. Par exemple : si cet en-tête a une valeur de 100 et que l’en-tête `X-HubSpot-RateLimit-Interval-Milliseconds` a la valeur 10 000, la limite appliquée sera de 100 requêtes toutes les 10 secondes.
`X-HubSpot-RateLimit-Remaining`	Le nombre de requêtes d’API encore autorisés pour la fenêtre indiquée dans `X-HubSpot-RateLimit-Interval-Milliseconds`

Remarque:

Les en-têtes X-HubSpot-RateLimit-Secondly et X-HubSpot-RateLimit-Secondly-Remaining sont toujours inclus et présentent des données précises. Cependant, la limite référencée par ces en-têtes n’est plus appliquée et ces deux en-têtes doivent être considérés comme obsolètes.
Les réponses des points de terminaison de l’API de recherche n’incluront aucun des en-têtes de limite de débit répertoriés ci-dessus.

Vous pouvez également vérifier le nombre d’appels utilisés le jour en cours à l’aide de ce point de terminaison. Si vous atteignez la limite TEN_SECONDLY_ROLLING, vous devez maintenir les requêtes de votre application sous cette limite. Par ailleurs, si vous atteignez la limite quotidienne, consultez les suggestions ci-dessous. Si vous atteignez toujours les limites d’appel après avoir suivi ces suggestions, veuillez publier sur nos forums des développeurs. Fournissez autant de détails que possible quant aux API utilisées, à leur utilisation et à la limite atteinte.

Utiliser les API de transfert en masse et les résultats du cache si possible

Si votre site ou votre application utilise des données de HubSpot sur chaque chargement de page, ces données doivent être mises en cache et chargées à partir de ce cache au lieu d’être demandées à chaque fois à partir des API de HubSpot. Si vous effectuez des appels répétés pour obtenir des paramètres depuis votre compte pour un traitement par lot (comme l’obtention de propriétés d’objet, de propriétaires ou de paramètres pour un formulaire), ces paramètres doivent également être mis en cache, le cas échéant.

Utiliser des webhooks pour obtenir des données actualisées depuis HubSpot

Si vous disposez d’un abonnement HubSpot Marketing Entreprise, vous pouvez utiliser des actions de webhook dans les workflows pour obtenir des données pour les fiches d’informations de contact envoyées à votre système. Les webhooks peuvent être déclenchés en tant qu’action dans n’importe quel workflow, afin que vous puissiez utiliser les conditions initiales de workflow comme critères pour l’envoi des données de contact à votre système. Pour en savoir plus sur l’utilisation des webhooks, consultez cet article et des exemples de données de webhooks ici. Les appels de webhook effectués via des workflows ne sont pas comptabilisés dans la limite de l’API.

​Authentification et sécurité

​Vérification de l’utilisation des API

​Applications privées

​Applications publiques utilisant OAuth

​Limites de taux

​Applications publiques

​Applications privées

​Remarque:

​Autres limites

​Limites de requête

​Limites de service

​Réponses d’erreur

​Remarque:

​Utiliser les API de transfert en masse et les résultats du cache si possible

​Utiliser des webhooks pour obtenir des données actualisées depuis HubSpot

Authentification et sécurité

Vérification de l’utilisation des API

Applications privées

Applications publiques utilisant OAuth

Limites de taux

Applications publiques

Applications privées

Remarque:

Autres limites

Limites de requête

Limites de service

Réponses d’erreur

Remarque:

Utiliser les API de transfert en masse et les résultats du cache si possible

Utiliser des webhooks pour obtenir des données actualisées depuis HubSpot