Ultima atualização: Junho 28, 2023
Disponível com qualquer uma das seguintes assinaturas, salvo menção ao contrário:
Todos os produtos e planos
|
Com a chave de API da HubSpot, seus desenvolvedores podem criar aplicativos personalizados com APIs da HubSpot. Cada chave é específica para uma conta da HubSpot, não para um usuário individual, e apenas uma chave é permitida por vez.
Observação: a partir de 30 de novembro de 2022, as chaves de API da HubSpot serão desativadas e não terão mais suporte. Em vez disso, você precisará autenticar usando um token de acesso a aplicativo privado ou OAuth. Saiba mais sobre essa alteração e como migrar uma integração de chave de API para usar um app privado.
Se vir um banner na sua conta sobre a desativação da chave de API:
- Verifique se você migrou todas as integrações afetadas e desative a chave de API.
- Para verificar se a chave de API da conta foi utilizada nos últimos sete dias, veja o histórico de registos de chamadas da sua chave de API. O registro de chamadas não mostrará solicitações feitas com a chave há mais de sete dias.
- Os aplicativos listados na página Aplicativos conectados nas configurações da sua conta não precisam de ser migrados, pois são autenticados com OAuth.
- As chaves de API de desenvolvedor são separadas das chaves de API padrão da HubSpot e não serão descontinuadas. As chaves de API de desenvolvedor são utilizadas para gerenciar as configurações relacionadas aos seus aplicativos HubSpot, incluindo assinaturas da API de webhooks e tipos de eventos da API de eventos de linha do tempo.
Acessar sua chave de API
Você deve ter permissões de Superadministrador para acessar a chave de API da sua conta.
- Na sua conta da HubSpot, clique em ícone de configuração na barra de navegação principal.
- No menu da barra lateral esquerda, acesse Integrações > Chave de API.
- Se uma chave nunca tiver sido gerada para sua conta, clique em Gerar chave de API.
- Se já tiver gerado uma chave de API, clique em Mostrar para exibir sua chave.
- Com a chave exibida, clique em Copiar para copiar a chave. Você pode colar a chave para fornecê-la aos desenvolvedores ou usá-la em seus aplicativos.
Revezar sua chave de API
Fornecer a chave de API para um desenvolvedor concederá o acesso completo para fazer alterações na sua conta por meio da API da HubSpot, incluindo ler e-mails registrados das contas de e-mail conectadas e outros dados de terceiros.
Para segurança adicional, considere alterar a chave de API da HubSpot a cada seis meses. Ao alterar sua chave de API da HubSpot, a chave existente será ativada e uma nova será gerada. A HubSpot exibirá a idade da chave de API e recomendará quando você deve alterá-la.
As notificações de e-mail são enviadas a cada 180 dias aos superadministradores e aos usuários que criaram ou alteraram a chave de API pela última vez, caso ela não tenha sido revezada nesse período.
Embora isso possa criar tempo de inatividade e exigir esforço, adiciona uma camada de segurança, impedindo que aplicativos mal-intencionados acessem suas informações da HubSpot usando a chave de API existente.
Para alterar a chave de API da HubSpot:
- 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 > Chave de API.
- Clique no menu suspenso Ações e selecione Alterar a chave.
- Clique em Alterar e expirar essa chave agora. Marque a caixa de seleção de reCAPTCHA. Sua chave existente será desativada e uma nova chave de API será criada.
- Clique em Copiar e substitua a chave de API desativada usada pelos aplicativos por essa nova chave de API.
As chamadas de API que usam essa chave de API da HubSpot falharão e os aplicativos que usam essa chave não poderão mais acessar suas informações.
Alterar a chave de API não afetará sua conexão com a integração do Salesforce. No entanto, se você tiver uma integração personalizada instalada, será necessário atualizar sua chave de API após alterná-la.
Observação:os aplicativos conectados instalados por meio do Marketplace de aplicativos não serão afetados ao alterar a chave de API.
Desativar sua chave de API
Desativar a chave de API não criará uma nova chave. Ocorrerão falhas nas chamadas de API usando a chave de API da HubSpot desativada e qualquer aplicativo que usa a chave não poderá mais acessar suas informações.
Para desativar a chave de API:- Na sua conta da HubSpot, clique em ícone de configuração na barra de navegação principal.
- No menu da barra lateral esquerda, acesse Integrações > Chave de API.
- Clique no menu suspenso Ações.
- Clique em Desativar chave e, em seguida, em Desativar esta chave agora. Marque a caixa de seleção de reCAPTCHA.
Exibir seu registro de auditoria de API
Veja um registro datado dos usuários que visualizaram, criaram ou desativaram a chave de API da conta na seção Registro de auditoria.
- Na sua conta da HubSpot, clique em ícone de configuração na barra de navegação principal.
- No menu da barra lateral esquerda, acesse Integrações > Chave de API.
- Clique na guia Registro de auditoria.
Exibir o registro de chamadas da chave de API
Para ajudar a depurar uma de suas integrações ou garantir que você esteja em conformidade com asDiretrizes de uso de APIs da HubSpot, você pode visualizar um registro das chamadas da chave de API dos últimos sete (7) dias.
- Na sua conta da HubSpot, clique em ícone de configuração na barra de navegação principal.
- No menu da barra lateral esquerda, acesse Integrações > Chave de API.
- Na guia Registro de chamadas, visualize todas as atividades dos últimos sete (7) dias.
