Diretrizes de uso de APIs

A HubSpot monitora o uso de nossas APIs públicas para garantir uma experiência de qualidade para todos os usuários. Todos os desenvolvedores de apps e integrações devem cumprir a Política de Utilização Responsável da HubSpot e os Termos de APIs. Embora a HubSpot se reserve o direito de alterar as APIs ou torná-las obsoletas ao longo do tempo, as atualizações sempre serão fornecidas por meio do log de alterações do desenvolvedor.

Autenticação e segurança

Para segurança ideal, todos os apps devem usar o protocolo OAuth da HubSpot diretamente ou o token de acesso do app se você estiver criando um app privado. Os aplicativos são responsáveis por armazenar dados de tempo de vida (TTL) e atualizar os tokens de acesso do usuário de acordo com esse protocolo. Quando um token de acesso for gerado, ele incluirá um parâmetro expires_in que indica por quanto tempo ele poderá ser usado para fazer chamadas de API antes de precisar ser atualizado. As solicitações Unauthorized (401) não são um indicador válido de que é preciso recuperar um novo token de acesso.

Apps privados

Para visualizar o uso da API para um aplicativo privado:

• Na sua conta da HubSpot, clique no ícone de configurações na barra de navegação principal.
• No menu da barra lateral esquerda, acesse Integrações > Aplicativos privados.
• Clique no nome do aplicativo privado.
• Na página de detalhes do aplicativo, clique na guia Registros.
• Revise as chamadas de API listadas na tabela. Você também pode usar barra de pesquisa, filtros e seletores de datas para refinar ainda mais as chamadas de API exibidas.

Saiba mais sobre como verificar o uso da API em aplicativos privados.

Aplicativos públicos que usam OAuth

Para visualizar o uso da API para um aplicativo público usando OAuth:

• Na sua conta de desenvolvedor, acesse Aplicativos na barra de navegação principal.
• Clique no nome do aplicativo.
• No menu da barra lateral esquerda, acesse Monitoramento.
• Use as guias para visualizar diferentes tipos de solicitações feitas para ou por meio do aplicativo. Ao visualizar esses registros, você pode clicar em uma solicitação individual para visualizar mais informações.

Saiba mais sobre como monitorar o uso da API para aplicativos públicos.

Aplicativos com OAuth

Para aplicativos OAuth, cada conta da HubSpot que instala o aplicativo está limitada a 100 solicitações a cada 10 segundos. Isso exclui a API de pesquisa, conforme observado na seção Outros limites abaixo. Limites relacionados ao complemento para API não se aplicam.

Apps privados

Cada aplicativo privado está sujeito às diretrizes de uso de APIs da HubSpot. O número de chamadas que seu aplicativo privado pode fazer se baseia na assinatura da sua conta e se você comprou o complemento de API:

• Você pode criar até 100 apps por conta de desenvolvedor.
• Você pode criar até 20 apps privados por conta da HubSpot.
• Você pode criar até 1.000 assinaturas de webhook por app.
• Você pode criar até 25 configurações de extensão de CRM por app.
• Você pode criar até 750 tipos de evento de linha do tempo por app.
• Você pode criar até 500 propriedades por tipo de evento de linha do tempo.
• Os endpoints da API de pesquisa são limitados a quatro solicitações por segundo por token de autenticação.

Saiba mais sobre os limites e preços de serviços aqui.

Qualquer aplicativo ou integração que exceda seus limites de taxa receberá uma resposta de erro 429 para todas as chamadas de API subsequentes. As solicitações que resultam em resposta de erro não devem exceder 5% das solicitações diárias. Se você planeja listar seu aplicativo no Marketplace de aplicativos da HubSpot, ele deverá estar abaixo desse limite de 5% para que seja certificado. 

A resposta 429 terá o seguinte formato: 

A message e o policyName indicarão o limite que você atingiu (diariamente ou por segundo).

O limite diário é redefinido meia-noite de acordo com sua configurações do fuso horário.

A tabela a seguir detalha os cabeçalhos de limite de taxa incluídos na resposta de cada solicitação de API para o HubSpot, sujeito às exceções listadas abaixo da tabela.

Você também pode verificar o número de chamadas usadas durante o dia atual usando este endpoint.

Se você se deparar com TEN_SECONDLY_ROLLING, acelere as solicitações que o aplicativo está fazendo para se manter abaixo desse limite. Confira as sugestões abaixo para acelerar as solicitações ou se você estiver atingindo o limite diário.

Se você perceber que, mesmo após ler essas sugestões, continua atingindo os limites de chamada, publique nos fóruns de desenvolvedores da HubSpot. Você deve incluir o máximo de detalhes possível sobre as APIs que está usando, como elas estão sendo usadas e qual o limite atingido.

Se seu site ou aplicativo usar dados do HubSpot em cada carregamento de página, esses dados deverão ser armazenados no cache e carregados dele, em vez de serem solicitados todas as vezes nas APIs da HubSpot. Se você estiver fazendo chamadas repetidas para obter configurações sobre sua conta para um trabalho em lote (como obter as propriedades do objeto, os proprietários ou as configurações de um formulário), essas configurações também deverão armazenadas no cache sempre que possível.

Se tiver uma assinatura do HubSpot Operations Professional, você poderá usar ações de webhook em fluxos de trabalho para que os dados de registros de contatos sejam enviados para o seu sistema. Os webhooks podem ser disparados como uma ação em qualquer fluxo de trabalho. Dessa forma, é possível usar condições iniciais de qualquer fluxo de trabalho como os critérios para que os dados de contato sejam enviados para o sistema. Encontre aqui mais detalhes sobre como usar webhooks e aqui um exemplo de dados de webhooks. As chamadas de webhook feitas por meio de fluxos de trabalho não contam para o limite de taxa da API.