API d’objet
Les API d’objet permettent d’accéder aux fiches d’informations et aux activités. Pour les objets pris en charge, vous pouvez utiliser les points de terminaison d’objet et remplacer{objectTypeId} dans l’URL de la requête par l’objet souhaité. Par exemple, pour créer des contacts, effectuez une requête POST à crm/v3/objects/0-1 et pour créer des formations, une requête à crm/v3/objects/0-410. Reportez-vous à cet article pour plus d’informations sur l’utilisation des points de terminaison d’objet pour divers objets.
ID de type d’objet
Lorsque vous utilisez le CRM et d’autres API, vous devez utiliser le champobjectTypeId, qui est une valeur numérique unique attribuée à chaque objet. Par exemple, pour récupérer des fiches d’informations, vous pouvez effectuer une requête GET à /crm/v3/objects/{objectTypeId}, ou lors de la création d’une propriété pour un objet, vous pouvez effectuer une requête POST à /crm/v3/properties/{objectTypeId}. Les valeurs d’ID de type d’objet sont répertoriées dans le tableau ci-dessous :
Bien que vous puissiez toujours utiliser la valeur d’ID de type numérique, dans certains cas, vous pouvez également utiliser le nom de l’objet pour les contacts, les entreprises, les transactions, les tickets ou les notes. Par exemple :
- Lors du démarrage d’un import avec l’API d’import,
columnObjectTypeIdspécifie à quel objet appartiennent les données de votre fichier. Pour importer des données pour les contacts, votre valeurcolumnObjectTypeIdpeut êtrecontactou0-1. - Lors de l’utilisation de l’API d’associations, les valeurs
fromObjectTypeettoObjectTypespécifient les objets et la direction de l’association. Pour afficher les types d’associations pour les contacts avec les entreprises, l’URL de votre requêteGETpeut êtrecrm/v4/associations/contact/company/labelsoucrm/v4/associations/0-1/0-2/labels.
Identifiants uniques et ID de fiche d’informations
Un identifiant unique est une valeur qui différencie une fiche d’information d’une autre dans le CRM, même si celles-ci présentent des informations identiques. Par exemple, une base de données peut avoir des fiches d’informations pour deux personnes appelées John Smith. Pour éviter l’envoi accidentel d’argent au mauvais John Smith, chaque fiche d’informations s’accompagne d’un numéro, d’un ID de fiche d’informations. Lorsqu’une fiche d’informations est créée dans HubSpot, un ID de fiche d’informations (hs_object_id) est généré automatiquement et doit être considéré comme une chaîne. Ces ID de fiche d’informations sont uniques pour chaque type d’objet. Un contact et une entreprise peuvent donc avoir le même ID. Pour les contacts et les entreprises, il existe des identifiants uniques supplémentaires, y compris les éléments email d’un contact et domain d’une entreprise. Vous pouvez également créer des propriétés d’identifiant unique personnalisées.
Dans les API du CRM, vous utiliserez des valeurs d’identifiant unique pour identifier et gérer des fiches d’informations spécifiques. Vous pouvez toujours utiliser une valeur hs_object_id de fiche d’informations, mais vous pouvez également utiliser des propriétés d’identifiant unique personnalisées pour certains points de terminaison, spécifiées par le paramètre idProperty. Par exemple, pour modifier un contact, vous pouvez exécuter une requête PATCH à /crm/v3/objects/0-1/{contactId} ou /crm/v3/objects/0-1/{contactEmail}?idProperty=email. Découvrez comment HubSpot gère la déduplication dans la base de connaissances.
API Associations
Dans HubSpot, vous pouvez montrer comment les objets sont liés les uns aux autres par des fiches d’informations associées. Par exemple, vous pouvez associer plusieurs contacts à une entreprise, puis associer l’entreprise et les contacts pertinents à une transaction. Lorsque vous utilisez les points de terminaison de l’API Associations, vous pouvez substituer des objets pour{toObjectTypeId} et {fromObjectTypeId} dans les URL et les corps de requête. Avant d’associer des fiches d’informations à plusieurs objets, vous pouvez récupérer des types d’association pour savoir quels objets peuvent être associés les uns aux autres. Par exemple, les contacts peuvent être associés à la plupart des objets, tandis que les factures ne peuvent être associées qu’aux contacts, entreprises, transactions, lignes de produit, remises, frais et taxes. Selon votre abonnement, vous pouvez décrire la relation spécifique entre les fiches d’informations à l’aide de libellés d’associations, et votre compte peut avoir des objets personnalisés supplémentaires, qui peuvent être associés aux autres objets standard. Découvrez-en davantage sur les relations d’objet et la gestion des associations en utilisant les points de terminaison des associations.
Si vous avez accès à un compte HubSpot, vous pouvez également examiner les relations des objets uniques de votre compte en accédant à l’outil de modèle de données.
API Propriétés
Les informations sur les fiches d’informations sont stockées dans des champs appelés propriétés, lesquelles sont ensuite organisées en groupes. HubSpot fournit un ensemble de propriétés par défaut pour chaque objet. Outre les propriétés par défaut pour chaque objet, vous pouvez stocker des données personnalisées en créant des propriétés personnalisées. Lorsque vous utilisez l’API Propriétés, vous pouvez remplacer des objets dans les points de terminaison pour créer et gérer les propriétés d’un objet. Par exemple,/crm/v3/properties/0-1 pour les propriétés de contact ou /crm/v3/properties/0-5 pour les propriétés de ticket. Découvrez-en davantage sur l’utilisation de l’API des propriétés dans cet article.
API Recherche
Pour filtrer et trier les fiches d’informations et les activités en fonction de leurs propriétés et associations, vous pouvez utiliser l’API de recherche. Lorsque vous utilisez les points de terminaison de recherche, remplacez la valeur{objectTypeId} par l’objet dans lequel vous souhaitez effectuer la recherche. Par exemple, pour rechercher des appels, vous devez effectuer une requête POST à /crm/v3/objects/0-48/search. Découvrez comment utiliser l’API de recherche du CRM dans cet article.