Skip to main content

Antes de começar

Antes de começar a usar o OAuth com o HubSpot, você precisará ter:
Você deve ser um Superadministrador para instalar um aplicativo em uma conta HubSpot.

Como ele funciona

O HubSpot oferece suporte ao tipo de concessão do Código de autorização do OAuth 2.0, que pode estar dividido em quatro etapas básicas:
  1. Seu aplicativo abre uma janela do navegador para enviar o usuário ao servidor HubSpot OAuth 2.0
  2. O usuário analisa as permissões solicitadas e concede acesso ao aplicativo
  3. O usuário é redirecionado de volta ao aplicativo com um código de autorização na sequência de consulta
  4. O aplicativo envia uma solicitação ao servidor OAuth 2.0 para trocar o código de autorização por um token de acesso

Neste guia

Todos os exemplos de código neste guia são desenvolvidos em JavaScript (Node.js)

Ínício rápido do aplicativo

Se esta for a primeira vez que você usa a autenticação OAuth com as APIs da HubSpot, é altamente recomendável que você verifique o Aplicativo de início rápido OAuth 2.0, escrito em Node.js. Este aplicativo de exemplo foi projetado para ajudá-lo a começar a usar o OAuth 2.0 o mais rápido possível, demonstrando todas as etapas descritas abaixo na seção sobre como obter tokens OAuth abaixo.

Obtenha o aplicativo de início rápido

Obtendo tokens OAuth

1. Crie o URL de autorização e direcione o usuário para o servidor OAuth 2.0 da HubSpot

Quando um usuário é direcionado para o servidor OAuth 2.0 da HubSpot, a primeira etapa consiste na criação do URL de autorização. Isso identificará seu aplicativo e definirá os recursos (escopos) cujo acesso ele está solicitando em nome do usuário. Os parâmetros de consulta que você pode passar como parte de um URL de autorização são mostrados na tabela abaixo. Para obter informações mais detalhadas sobre essa etapa, leia o documento de referência.

Campos marcados com * são obrigatórios.

Depois de criar sua URL, inicie o processo de conexão do OAuth enviando o usuário para ela. Os blocos de código abaixo fornecem exemplos de uso de diferentes tipos de redirecionamento: Usando um redirecionamento do lado do servidor:
Usando um link HTML:
Codificando um estado de usuário de redirecionamento adicional: Alguns aplicativos podem precisar redirecionar o usuário para locais diferentes. Por exemplo, um aplicativo pode desejar redirecionar usuários para diferentes subdomínios de sua integração (por exemplo userA.integration.com e userB.integration.com). Para fazer isso, use o parâmetro state para codificar mais informações sobre o estado do usuário: 1. Gerencie e armazene um valor nonce para o parâmetro state. 2. Armazene o estado do usuário em um armazenamento de dados local usando o nonce como sua chave. 3. Inclua o valor nonce como o parâmetro state no URL de autorização. 4. Quando o usuário for autenticado e redirecionado para o URL de redirecionamento, valide o parâmetro state e use-o como a chave para recuperar o estado do usuário que foi armazenado. 5. Depois, redirecione o usuário conforme necessário (por exemplo, redirecionar novamente para um URL específico do usuário).

2. A HubSpot solicita o consentimento do usuário

O HubSpot exibe uma janela de consentimento para o usuário mostrando o nome do aplicativo e uma descrição resumida dos serviços de API do HubSpot a que está solicitando permissão de acesso. O usuário pode conceder acesso ao aplicativo.
Exemplo de janela de prompt de instalação
Observação: o usuário que está instalando o aplicativo deve ter acesso a todos os escopos solicitados. Se ele não tiver o acesso exigido, a instalação falhará e ele será direcionado a uma página de erro. Se esta página de erro de permissões for exibida para um usuário, ele precisará ser um Superadministrador para instalar o aplicativo. Neste estágio, seu aplicativo não faz nada. Assim que o acesso for concedido, o servidor OAuth 2.0 da HubSpot enviará uma solicitação para o URI de retorno definido no URL de autorização.

3. Manipule a resposta do servidor OAuth

Depois que o usuário concluir a solicitação de consentimento na Etapa 2, o servidor OAuth 2.0 enviará uma solicitação GET para o URI especificado em seu URL de autenticação. Se não houver problemas e o usuário aprovar a solicitação de acesso, a solicitação para o URI de redirecionamento será devolvida com um parâmetro de consulta code anexado. Se o usuário não conceder acesso, nenhuma solicitação será enviada. Exemplo:

4. Código de autorização de troca para tokens

Após seu aplicativo receber um código de autorização do servidor OAuth 2.0, ele poderá trocar esse código para um token de acesso e atualização enviando uma solicitação POST codificada por formulário para https://api.hubapi.com/oauth/v1/token com os valores mostrados abaixo. Para obter informações mais detalhadas sobre essa etapa, reserve um tempo para ler este documento de referência. Exemplo:
O corpo da resposta do token será dados JSON:

Observação:

O token de acesso irá expirar após o número de segundos fornecido no campo expires_in da resposta, atualmente 30 minutos. Para obter detalhes sobre como obter um novo token de acesso, consulte a seção Atualizando tokens OAuth abaixo.

Usando tokens OAuth

Assim que o fluxo de código de autorização for concluído, seu aplicativo estará autorizado a fazer solicitações em nome do usuário. Para fazer isso, forneça o token como um token bearer no cabeçalho HTTP Authorization. Detalhes específicos podem ser encontrados no documento de referência. Exemplo:

Observação:

Os tokens de acesso refletem os escopos solicitados do aplicativo e não refletem as permissões ou limitações do que um usuário pode fazer em sua conta HubSpot. Por exemplo, se um usuário tiver permissões para visualizar apenas contatos de propriedade, mas autorizar uma solicitação para o escopo crm.objects.contacts.read, o token de acesso resultante poderá visualizar todos os contatos na conta e não apenas aqueles de propriedade do usuário que está autorizando.

Atualizando tokens OAuth

Os tokens de acesso OAuth expiram periodicamente. A finalidade é garantir que, se ele estiver comprometido, os participantes só terão acesso por um curto período. O tempo de vida útil do token em segundos é especificado no campo expires_in quando um código de autorização é trocado para um token de acesso. Seu aplicativo pode trocar o token de atualização recebido por um novo token de acesso enviando uma solicitação POST para https://api.hubapi.com/oauth/v1/token com os valores abaixo. Para obter informações mais detalhadas sobre essa etapa, consulte o documento de referência. Exemplo:
O corpo da resposta do token será dados JSON:
O novo token de acesso pode ser usado para fazer chamadas em nome do usuário. Quando o novo token expirar, siga as mesmas etapas novamente para recuperar um novo token.

Artigos relacionados

Métodos de Autenticação no HubSpot Trabalhando com o OAuth Gerenciar tokens
Última modificação em 10 de fevereiro de 2026