Documentação de referência de API da HubSpot

A plataforma de desenvolvedor da HubSpot é parte essencial da nossa missão de capacitar as empresas a alcançarem um crescimento melhor. Nossas APIs são desenvolvidas com o intuito de permitir que qualquer equipe seja capaz de criar integrações eficazes para personalizar e aproveitar ao máximo o HubSpot.

Todas as APIs da HubSpot são criadas usando convenções REST e projetadas para ter uma estrutura de URL previsível. Elas usam vários recursos HTTP padrão, inclusive métodos (POST, GET, PUT, DELETE) e códigos de resposta de erro. Todas as chamadas de API da HubSpot são feitas em https://api.hubapi.com e todas as respostas retornam um JSON padrão.

Configurando

Há várias maneiras de criar integrações com o HubSpot:

• Para criar uma integração interna para uma conta individual da HubSpot (por exemplo, você deseja criar um aplicativo que possa acessar e editar apenas partes autorizadas da sua conta para compartilhar ou integrar com outras partes da sua organização), crie um aplicativo privado.
• Se você quiser criar um aplicativo público que possa ser instalado em várias contas da HubSpot, crie uma conta de desenvolvedor. Há vários motivos para isso: é em uma conta de desenvolvedor que você cria aplicativos da HubSpot, cada um deles autenticado com OAuth e fornecido com um conjunto configurável de recursos e permissões. Você também pode usar sua conta de desenvolvedor para criar contas de teste, monitorar o status e o desempenho do aplicativo ou publicar aplicativos para o Marketplace de aplicativos da HubSpot.

Saiba mais sobre os diferentes tipos de aplicativos e tipos de conta neste artigo.

Bibliotecas do cliente

As bibliotecas do cliente são projetadas para ajudar você a interagir facilmente com as APIs da HubSpot. Elas são criadas em várias linguagens diferentes e ajudam a relacionar seu aplicativo e às APIs da HubSpot. Por exemplo, com elas, você não precisa saber quais são o URL e o método HTTP exatos necessários para usar para cada chamada de API e, assim, tem mais tempo para focar na criação do aplicativo. Saiba mais sobre nossas bibliotecas de cliente aqui

Documentação das APIs

A documentação das APIs da HubSpot divide-se em duas seções: documentos de referência e guias de integração.

Documentos de referência

Todos os documentos de referência de API contêm uma seção de visão geral e uma seção de endpoint. A visão geral da API inclui um breve resumo da funcionalidade, casos de uso e quaisquer considerações especiais necessárias à criação de uma integração. A seção de endpoints lista cada endpoint, os respectivos parâmetros e exemplos de solicitações em várias linguagens.

Depois de definir as configurações de autenticação do aplicativo em sua conta do desenvolvedor, você poderá usar o Postman ou fazer chamadas de teste diretamente em uma página de referência de endpoint. 

Guias de integração

Para aprender os fundamentos da plataforma da HubSpot ou ver um exemplo antes de fazer sua primeira chamada de API, consulte na nossa seção de Guias de integração. Nela, você encontra exemplos de aplicativos e tutoriais, bem como informações detalhadas sobre contas de desenvolvedores, como trabalhar com o OAuth, limites de taxa de API e muito mais. 

Relacionado: saiba mais sobre métodos de autenticação ou OAuth.

Criando a lista

Quando você estiver pronto para compartilhar seu aplicativo com o mundo e se tornar um parceiro de aplicativo, leia os requisitos para listagem e certificação. Depois disso, você poderá criar e gerenciar sua lista do Marketplace de aplicativos diretamente em sua conta de desenvolvedor.

Recursos de suporte e da comunidade

Veja as respostas às suas perguntas, faça conexões e compartilhe seus insights participando dos fóruns das comunidades de desenvolvedores e da comunidade Slack da HubSpot em constante expansão. Esses fóruns são o local ideal para expressar suas opiniões e ideias. O feedback da comunidade é extremamente importante para nós e para nossos esforços contínuos de melhorar a experiência dos desenvolvedores do HubSpot.

Inscreva-se no Log de alterações e esteja por dentro de novos recursos, anúncios e alterações importantes.

Criando no CMS

Está interessado em criar um site, um blog, uma página inicial, um aplicativo leve ou um e-mail? Confira nossos documentos de desenvolvedor do CMS.

Documentos relacionados

Como usar as APIs da HubSpot