Visão geral do desenvolvimento de apps

Os apps são um pacote de qualquer funcionalidade que você deseja compartilhar com usuários da HubSpot ou com outra conta da HubSpot. Os apps também permitem que você desenvolva usando recursos como cartões de CRM personalizados, eventos de linha do tempo e webhooks. Durante o desenvolvimento do app, a HubSpot tem várias ferramentas para colocar seu app ou sua integração em execução. Abaixo, saiba mais sobre os componentes do desenvolvimento de apps. 

Contas

Embora as contas de desenvolvedor de app e as contas de teste funcionem em conjunto, elas possuem propósitos diferentes.

  • As contas de desenvolvedor são aquelas em que você pode criar e listar apps.
  • As contas de teste permitem que você experimente nossas APIs e teste os apps que está criando sem comprometer os dados de uma conta real do HubSpot. Isso é separado de uma conta de área restrita que você pode criar em contas padrão do HubSpot.

Saiba mais sobre os tipos de conta da HubSpot.

Autenticação

Se quiser criar uma integração personalizada com uma única conta do HubSpot, você pode criar um app privado e usar seu token de acesso para autenticar chamadas de API ou usar uma chave de API. Qualquer app desenvolvido para ser instalado em várias contas da HubSpot ou para listagem no marketplace de apps deve usar o OAuth

Observação: a partir de 30 de novembro de 2022, as chaves de API da HubSpot não poderão mais ser usadas como um método de autenticação para acessar as APIs da HubSpot. Além disso, a partir de 15 de julho de 2022, as contas sem uma chave de API da HubSpot gerada não poderão mais criar uma.

Em vez disso, você precisará usar um token de acesso a um app privado ou OAuth para autenticar chamadas de API. Saiba mais sobre essa alteração e como migrar uma integração de chave de API para usar um app privado.

Se quiser se inscrever em webhooks ou configurar o OAuth para seu app, você deve criar uma conta de desenvolvedor. Com as contas de desenvolvedor, você também pode listar seus apps no marketplace de apps ou criar uma conta de teste.

Chaves de API da conta de desenvolvedor

Para gerenciar as configurações do app por meio da API, você pode usar uma chave de API do desenvolvedor. Isso inclui gerenciar inscrições da API de Webhooks e criar ou atualizar tipos de evento do recurso de eventos de linha do tempo.

As chaves de API de desenvolvedor só podem ser usadas para fazer chamadas de API para atualizar configurações de um app. Todas as outras chamadas de API precisam ser feitas usando um token de acesso ao app privado ou OAuth.

Para acessar sua chave de API de conta de desenvolvedor de apps:

  • Na sua conta de desenvolvedor de apps, acesse Apps na barra de navegação superior.
  • No canto superior direito, clique na chave de API do Get HubSpot.
  • Na caixa de diálogo, clique em Mostrar chave. A tecla será revelada e você poderá clicar em Copiar próximo à tecla.
  • Também é possível desativar a chave de API anterior e gerar uma nova clicando em Gerar novamente a chave.

show_dev_api_key

App ID

Durante o desenvolvimento do seu app, você pode encontrar o seu ID em dois locais: 

  • Abaixo do nome do app no painel Apps de sua conta de desenvolvedor:
Screen Shot 2020-01-15 at 2
  • Nas Configurações de autenticação do app:

app_auth_id_settings

 

Monitoring app behavior

O HubSpot registra todas as solicitações feitas para um app conectado, incluindo solicitações recebidas usando um token de acesso OAuth ou solicitações enviadas para webhooks ou cartões de CRM. 

Para visualizar este registro de solicitação:

  • Na sua conta de desenvolvedor de apps, navegue até Apps na barra de navegação principal.
  • Clique no nome do aplicativo.
  • No menu da barra lateral esquerda, acesse Monitoramento

app_monitoring

  • Use as guias para visualizar diferentes tipos de solicitações feitas para ou por meio do app. Ao visualizar esses registros, você pode clicar em uma solicitação individual para visualizar mais informações sobre ela, incluindo:
    • para solicitações bem-sucedidas, o método, o caminho e o horário da solicitação.
    • para solicitações malsucedidas, informações de erro adicionais, como cabeçalhos de resposta e corpo.

request_details

Abaixo, saiba mais sobre cada guia da página Monitoramento.

Chamadas de API

O log de chamadas de API listará todas as solicitações feitas no aplicativo usando um token de acesso OAuth. Ele pode ser filtrado por método HTTP, código de resposta, período ou URL de solicitação.

api_calls_monitoring-1

Webhooks

A guia Webhooks mostra solicitações do HubSpot para qualquer uma das inscrições de webhook do aplicativo. Filtre por resposta (inclusive tempo limite e falhas de conexão), status (sucesso, nova tentativa ou falha), tipo de assinatura, período de tempo, tentativa, lote, evento ou ID da conta. 

Please note: the attempt ID is a combination of the subscriptionId, eventId, and attemptNumber from a specific request.

webhook_monitoring

Extensões de CRM

Você encontrará solicitações do HubSpot para os cartões do CRM do aplicativo na guia Extensões de CRM. Filtre por tipo de objeto de extensão, tipo de objeto de CRM (contato, empresa, ticket ou negócio), erro ou tipo de aviso, período de tempo, ID da solicitação ou ID de registro de CRM (ou seja, um ID de contato específico).

Delete a developer account

É possível excluir contas de desenvolvedor de app se elas não contiverem apps com instalações ou listas de marketplace ativas. Se sua conta tiver aplicativos com instalações ou com listas de marketplace ativas e você quiser excluí-la, entre em contato com o suporte para obter assistência.

Depois de excluir sua conta, você não poderá mais acessá-la. Se você puder alternar entre várias contas da HubSpot, a conta excluída não aparecerá mais.

Na conta de desenvolvedor de API da HubSpot, clique no nome da sua conta no canto superior direito e depois clique em Conta.

account

Clique em Excluir conta. Se sua conta tiver aplicativos com instalações ou listas de marketplace ativas, esse botão aparecerá desativado.

Account2

Na caixa de diálogo, insira o ID da conta e clique em Excluir conta de desenvolvedor

Confirm2

 

Documentos relacionados

Criando e instalando aplicativos

Criar uma conta de desenvolvedor

Criar uma conta de teste

Configurar uma conta de área restrita da HubSpot (BETA)