Private apps

Os aplicativos privados permitem usar as APIs da HubSpot para acessar dados específicos da sua conta da HubSpot. Você pode autorizar o que cada aplicativo privado pode solicitar ou alterar em sua conta, o que gerará um token de acesso exclusivo para seu aplicativo. 

Você precisa ser um superadministrador para acessar os aplicativos privados na sua conta da HubSpot.

Observação: aplicativos privados não oferecem suporte a eventos de linha do tempo personalizados. Os webhooks são compatíveis com aplicativos privados, mas as assinaturas não podem ser editadas programaticamente por meio de uma API e, em vez disso, devem ser editadas nas configurações do aplicativo privado.

Se você planeja criar um aplicativo que usa eventos de linha do tempo personalizados, crie um aplicativo público. Saiba mais sobre a diferença entre aplicativos privados e públicos.

Criar um aplicativo privado

  • Na sua conta da HubSpot, clique no ícone de configurações na barra de navegação principal.
  • No menu lateral esquerdo, acesse Integrações > Aplicativos privados.
  • Clique em Criar aplicativo privado.
  • Na guia Informações básicas, configure os detalhes do aplicativo:
    • Insira o nome do aplicativo.
    • Passe o cursor do mouse sobre o logotipo de espaço reservado e clique no ícone de upload para carregar uma imagem quadrada que servirá como logotipo do seu aplicativo.
    • Insira uma descrição para o aplicativo.
  • Clique na guia Escopos.
  • Marque a caixa de seleção Leitura ou Gravação para cada escopo que você deseja que seu aplicativo privado possa acessar. Você também pode pesquisar um escopo específico usando a barra de pesquisa Encontrar um escopo.
  • Quando terminar de configurar seu aplicativo, clique em Criar aplicativo no canto superior direito.

updated-read-write-scope-config-private-apps

  • Na caixa de diálogo, revise o as informações sobre o token de acesso do seu aplicativo e clique em Continuar criando.

Depois de criar seu aplicativo, você pode começar a fazer chamadas de API usando o token de acesso do aplicativo. Se você precisar editar as informações do seu aplicativo ou alterar os escopos, clique em Editar detalhes.

edit-details-of-private-app

 

Fazer chamadas de API com seu token de acesso

Observação: os aplicativos privados perderão o acesso aos escopos quando sua conta da HubSpot sofrer o downgrade e perder o acesso à funcionalidade. Por exemplo, se a sua conta não tiver acesso ao HubDB, o seu aplicativo privado não terá acesso ao escopo do HubDB.

Os tokens de acesso ao aplicativo privado serão atualizados para refletir os escopos disponíveis na sua conta da HubSpot e o que você configurou para o aplicativo privado, mas a string do token não será alterada. 

Para começar a fazer chamadas de API, acesse a página de detalhes do aplicativo.

  • No cartão Token de acesso, clique em Mostrar token para revelar seu token de acesso. Clique em Copiar para copiar o token para a área de transferência.

show-private-app-access-token-1

  • Você pode colar o token de acesso para fornecê-lo aos desenvolvedores ou usá-lo para desenvolver seu aplicativo. Ao fazer uma chamada para um dos endpoints de API da HubSpot, defina o valor do campo Autorização como Portador [YOUR_TOKEN]. Por exemplo, se você estiver fazendo uma chamada para a API de contatos usando Node.js e axios, a solicitação será parecida com a seguinte:
axios.get('https://api.hubapi.com/crm/v3/objects/contacts', { headers: { 'Authorization': `Bearer ${YOUR_TOKEN}`, 'Content-Type': 'application/json' } }, (err, data) => { // Handle the API response } );
  • Os tokens de acesso para aplicativos privados são implementados na OAuth, para que você também possa fazer chamadas autenticadas usando uma das bibliotecas de cliente do HubSpot. Por exemplo, se você estiver usando abiblioteca de clientes Node.js, poderá iniciar um cliente OAuth passando o token de acesso do seu aplicativo:
const hubspotClient = new hubspot.Client({ accessToken: YOUR_ACCESS_TOKEN });

Visualizar informações do token de acesso do aplicativo privado

Para ver informações sobre o token de acesso de um aplicativo privado, como o Hub ID e os escopos associados ao token, faça uma solicitação POST para /oauth/v2/private-apps/get/access-token-info. No corpo da solicitação, inclua o token de acesso:

// POST request response body { "tokenKey": {{accessToken}} }

A resposta incluirá informações sobre o usuário que criou o token, o Hub ID da conta, o ID do aplicativo privado e os escopos associados ao token.

// Example response body { userId:123456, hubId:1020304, appId:2011410, scopes:[ "oauth", "crm.schemas.companies.write"] }

Revezar token de acesso

Se o token de acesso for perdido ou comprometido, você poderá revezá-lo. Um novo token de acesso será criado e o original expirará.

  • Na sua conta da HubSpot, clique na página Configurações na barra de navegação principal.
  • Acesse Integrações > Aplicativos privados.
  • Clique no nome do seu aplicativo privado.
  • Ao lado do token de acesso, clique em Revezar:
    • Se seu token for comprometido e você quiser revogar o acesso imediatamente, clique em Revezar e expirar agora.
    • Se não houver ameaça iminente ao seu token, ainda é recomendável revezar seu token a cada seis meses. Se você estiver pronto para iniciar um revezamento regular do seu token, clique em Revezar e expirar mais tarde, o que acionará a expiração do token em 7 dias.
      • Se seu aplicativo já estiver pronto para fazer a transição, você pode clicar em Expirar agora.
      • Se você decidir que precisa de mais tempo, pode clicar em Cancelar revezamento, que cancelará a expiração do token original e revogará o novo token de acesso.

rotate-private-app-access-token

O HubSpot também enviará notificações por e-mail aos superadministradores com lembretes sobre o status de revezamento do token de acesso, bem como outros alertas relacionados. Os superadministradores na sua conta da HubSpot receberão notificações para os seguintes eventos e lembretes:

  • Um superadministrador iniciou um revezamento (imediatamente ou agendado para daqui a sete dias).
  • Um superadministrador cancelou um revezamento pendente.
  • Um superadministrador optou por expirar um token de acesso imediatamente, clicando em Expirar agora, em vez de esperar sete dias para a expiração do token.
  • O token de acesso do aplicativo está prestes a expirar em 24 horas.
  • O token de acesso do aplicativo teve revezamento e expirou após sete dias.
  • Se não tiver revezado o seu token de acesso em mais de 180 dias, os superadministradores também receberão um e-mail de lembrete para revezar o token de acesso do seu aplicativo.

Exibir logs de chamadas de API

Para revisar as chamadas de API que seu aplicativo fez nos últimos 30 dias:

  • Na página de detalhes do aplicativo, clique na guia Logs.
  • Revise e filtre suas chamadas de API do aplicativo privado:
    • Clique nos menus suspensos Método e Resposta para filtrar suas chamadas de API históricas por método de solicitação ou código de resposta.
    • Clique no menu suspenso data de início ou data de término para limitar os logs de chamada a um intervalo de tempo específico.
    • Você também pode pesquisar chamadas específicas por URL na caixa de pesquisa Pesquisar por URL de solicitação.

review-private-app-call-logs

  • Para exportar os registros das chamadas de API, clique em Exportar registros (CSV). Em seguida, especifique um intervalo de datas (até os últimos 30 dias) e clique em Exportar.
  • Na caixa pop-up, selecione o intervalo de datas das chamadas de API que deseja exportar e clique em Exportar. Você receberá um e-mail com um link de download quando a exportação estiver pronta. 

Limites de aplicativos privados

Você pode criar até 20 aplicativos privados na sua conta da HubSpot. 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:

  Nível de produto Por 10 segundos Por dia
Aplicativos privados

(Qualquer Hub)

Gratuito e Starter

100/aplicativo privado 250.000/conta
 

(Qualquer Hub)

Pro e Enterprise

150/aplicativo privado 500.000/conta
Aplicativos privados com o complemento de API

(Qualquer Hub)

Gratuito, Starter, Professional e Enterprise

200/aplicativo privado 1.000.000/conta

Se você tiver um plano Starter e Professional, os limites para o nível mais alto (Professional) se aplicam à sua conta. 

Excluir um aplicativo privado

Quando você exclui um aplicativo privado, seu token de acesso é revogado permanentemente e você não pode mais usá-lo para fazer chamadas de API.

Para excluir um aplicativo:

  • Na sua conta da HubSpot, clique no ícone de configurações na barra de navegação principal.
  • Clique no nome do seu aplicativo privado.
  • Na parte inferior da página, clique em Excluir [nome do aplicativo].
  • Na caixa de diálogo, digite o nome do seu aplicativo para confirmar a exclusão e clique em Excluir.

Este artigo foi útil?
Este formulário deve ser usado apenas para fazer comentários sobre esses artigos. Saiba como obter ajuda para usar a HubSpot..