APIs de objetos
As APIs de objetos fornecem acesso a registros e atividades. Para objetos suportados, você pode usar pontos de extremidade de objeto e substituir{objectTypeId} na URL de solicitação com o objeto desejado. Por exemplo, para criar contatos, você faria uma POST solicitação para crm/v3/objects/0-1 e para criar cursos, a solicitação seria crm/v3/objects/0-410. Consulte este artigo para obter mais informações sobre o uso de endpoints de objeto para vários objetos.
IDs de tipo de objeto
Ao usar CRM e outras APIs, você precisará usar o campoobjectTypeId, que é um valor numérico exclusivo atribuído a cada objeto. Por exemplo, para recuperar registros, você faria um pedido GET para /crm/v3/objects/{objectTypeId}, ou ao criar uma propriedade para um objeto, você faria um POST pedido para /crm/v3/properties/{objectTypeId}Os valores de ID do tipo de objeto estão listados na tabela abaixo:
Você sempre pode usar o valor de ID do tipo numérico, mas, em alguns casos, também pode usar o nome do objeto para contatos, empresas, negócios, tickets ou notas. Por exemplo:
- Ao iniciar uma importação com a API de importações, o
columnObjectTypeIdespecifica a qual objeto pertencem os dados em seu arquivo. Para importar dados de contatos, seu valor paracolumnObjectTypeIdpode sercontactou0-1. - Ao usar a API de associações, os valores
fromObjectTypeetoObjectTypeespecificam os objetos e a direção da associação. Para exibir os tipos de associação de contatos para empresas, seu URL de solicitaçãoGETpode sercrm/v4/associations/contact/company/labelsoucrm/v4/associations/0-1/0-2/labels.
Identificadores exclusivos e IDs de registro
Um identificador exclusivo é um valor que diferencia um registro em um CRM de outro, mesmo que eles tenham informações idênticas. Por exemplo, no banco pode haver registros de duas pessoas com o nome John Smith. Para evitar o envio acidental de dinheiro para o John Smith errado, cada registro recebe um número como seu ID do registro. Quando um registro é criado na HubSpot, seu ID do registro (hs_object_id) é gerado automaticamente e deve ser tratado como uma string. Os IDs de registro são exclusivos dentro de um objeto, portanto, pode haver um contato e uma empresa com o mesmo ID. Para contatos e empresas, há identificadores exclusivos adicionais, incluindo o email de um contato e o nome de domain de uma empresa. Você também pode criar propriedades de identificador exclusivas personalizadas.
Nas APIs de CRM, você usará valores de identificadores exclusivos para identificar e gerenciar registros específicos. Você sempre pode usar um registro hs_object_id valor, mas também pode usar propriedades de identificador exclusivo personalizadas para determinados pontos de extremidade, especificados pelo idProperty parâmetro. Por exemplo, para editar um contato, você pode fazer um PATCH pedido para /crm/v3/objects/0-1/{contactId} ou /crm/v3/objects/0-1/{contactEmail}?idProperty=email. Saiba mais sobre como o HubSpot lida com a desduplicação no Base de conhecimento.
API de associações
Na HubSpot, você pode mostrar como os objetos estão relacionados entre si associando seus registros. Por exemplo, você pode associar vários contatos a uma empresa e, em seguida, associar a empresa e os respectivos contatos a um negócio. Ao usar os endpoints de API de associações, você pode substituir objetos por{toObjectTypeId} e {fromObjectTypeId} nos URLs e corpos de solicitação. Antes de associar registros entre objetos, para entender quais objetos podem ser associados uns aos outros, você pode recuperar tipos de associação. Por exemplo, contatos podem ser associados à maioria dos objetos, enquanto faturas só podem ser associadas a contatos, empresas, negócios, itens de linha, descontos, taxas e impostos. Dependendo da sua assinatura, você pode descrever os tipos de relacionamento específicos entre registros usando rótulos de associação, e sua conta pode ter objetos personalizados adicionais, que podem ser associados a outros objetos padrão. Saiba mais sobre relações entre objetos e gerenciamento de associações usando os pontos de extremidade de associações.
Se você tiver acesso a uma conta da HubSpot, poderá revisar as relações entre objetos exclusivos da sua conta, acessando a ferramenta de modelo de dados.
API de propriedades
As informações sobre registros são armazenadas em campos chamados de propriedades, que são então organizados em grupos. O HubSpot fornece um conjunto de propriedades padrão para cada objeto. Além de cada propriedade padrão do objeto, você pode armazenar dados personalizados criando propriedades personalizadas. Ao usar a API de propriedades, você pode substituir objetos nos endpoints para criar e gerenciar as propriedades de um objeto. Por exemplo,/crm/v3/properties/0-1 para propriedades de contato ou /crm/v3/properties/0-5 para propriedades de tickets. Saiba mais sobre como usar a API de propriedades neste artigo.
API de pesquisa
Para filtrar e classificar registros e atividades com base em suas propriedades e associações, você pode usar a API de pesquisa. Ao usar os pontos de extremidade de pesquisa, substitua o valor{objectTypeId} para o objeto no qual você deseja pesquisar. Por exemplo, para pesquisar chamadas, você faria uma solicitação POST para /crm/v3/objects/0-48/search. Saiba mais sobre como usar a API de pesquisa do CRM neste artigo.