Aplicativos privados

​

Criar um aplicativo privado

• Na sua conta HubSpot, clique em í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.
• Na parte superior da página, clique em Adicionar novo escopo.
• No painel direito, marque a caixa de seleçã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. Você pode revisar uma lista completa dos escopos disponíveis neste artigo de referência.
  • Clique em Atualizar quando terminar de adicionar escopos. Se mais tarde você decidir que seu aplicativo requer escopos adicionais, também poderá configurá-los depois que o aplicativo for criado.

• Revise os escopos que você selecionou para seu aplicativo. Se decidir que seu aplicativo não requer um escopo específico, você pode clicar em Excluir ao lado desse escopo para removê-lo. Você também pode clicar em Resumo dos escopos selecionados para exibir um detalhamento dos escopos do seu aplicativo e o acesso associado concedido a cada um deles.

• Para assinar eventos disparados por alterações em objetos do CRM na sua conta, você pode configurar assinaturas de webhook para seu aplicativo privado:
  • No canto superior da página, clique na guia Webhooks.
  • Sob o URL de destino, entre no URL que a HubSpot fará uma solicitação POST para quando os eventos são acionados.
  • Clique em Criar assinatura.
  • No painel direito, selecione os tipos de objeto que você deseja assinar e, em seguida, selecione os eventos associados a esses objetos (por exemplo, criados, mesclados, excluídos etc.) que farão o HubSpot enviar uma solicitação ao ponto de extremidade que você configurou.
  • Se você selecionar um tipo de objeto que requer escopos adicionais que você não autorizou, será solicitado a adicionar esses escopos ao seu aplicativo.
  • Se você selecionar Propriedade alterada para o tipo de evento, você pode selecionar uma das propriedades de objeto associadas para inscrever nas alterações.
  • Clique em Assinar.

• Se você não quiser que suas assinaturas de webhook estejam ativas imediatamente ou se quiser excluir uma assinatura criada por engano, você pode passar o mouse sobre o webhook e gerenciar seu status, cancelar a assinatura para excluí-la ou revisar os detalhes da assinatura. Saiba mais sobre como usar assinaturas de webhook em um aplicativo privado neste artigo.

• Quando terminar de configurar seu aplicativo, clique em Criar aplicativo no canto superior direito.
• Na caixa de diálogo, revise o as informações sobre o token de acesso do seu aplicativo e clique em Continuar criando.

​

Fazer chamadas de API com seu token de acesso

• Na sua conta HubSpot, clique em ícone de configurações na barra de navegação principal.
• No menu lateral esquerdo, acesse Integrações > Aplicativos privados.
• Clique no nome do aplicativo.
• Clique na guia Autenticação e clique em Mostrar token para revelar seu token de acesso. Clique em Copiar para copiar o token para a área de transferência.

• 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 pontos de extremidade 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

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

// Example response for GET request to /oauth/v2/private-apps/get/access-token-info
{
  "userId": 123456,
  "hubId": 1020304,
  "appId": 2011410,
  "scopes": ["oauth", "crm.schemas.companies.write"]
}

​

Revezar token de acesso

• 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.

• 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

• 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.

• 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

​

Excluir um aplicativo privado

• Na sua conta HubSpot, clique em ícone de configurações na barra de navegação principal.
• Clique no nome do seu aplicativo privado.
• No canto superior da página, clique na guia Autenticação.
• 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.