> ## Documentation Index
> Fetch the complete documentation index at: https://br.developers.hubspot.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Aplicativos privados
> Saiba como criar aplicativos privados no HubSpot.
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](https://knowledge.hubspot.com/pt/user-management/hubspot-user-permissions-guide#super-admin) 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](/apps/legacy-apps/private-apps/create-and-edit-webhook-subscriptions-in-private-apps), 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](/apps/legacy-apps/overview).
## 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](/apps/legacy-apps/authentication/scopes).
* 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](/apps/legacy-apps/private-apps/create-and-edit-webhook-subscriptions-in-private-apps).
* 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**.
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 aplicativo** no canto superior direito da página de detalhes do aplicativo.
## 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.
* 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](/api-reference/crm-contacts-v3/guide) usando Node.js e [axios](https://www.npmjs.com/package/axios), a solicitação será parecida com a seguinte:
```js theme={null}
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 a[biblioteca de clientes Node.js](https://github.com/HubSpot/hubspot-api-nodejs), poderá iniciar um cliente OAuth passando o token de acesso do seu aplicativo:
```js theme={null}
const hubspotClient = new hubspot.Client({ accessToken: YOUR_ACCESS_TOKEN });
```
### Observação:
Se você [remover o usuário](https://knowledge.hubspot.com/pt/user-management/deactivate-hubspot-users) que criou originalmente um aplicativo privado, todas as chamadas de API que usaram anteriormente o token de acesso do aplicativo falharão com um `result` de `"USER_DOES_NOT_HAVE_PERMISSIONS"`. Se esse problema ocorrer, é recomendável que você siga [as instruções na seção abaixo](#rotate-your-access-token) para rotacionar seu token de acesso.
Se você removeu o usuário da sua conta por engano, [adicioná-lo de volta](https://knowledge.hubspot.com/pt/account-management/add-and-remove-users) também corrigirá o problema.
## 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:
```json theme={null}
// 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.
```json theme={null}
// 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
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.
O HubSpot também enviará notificações por e-mail aos [superadministradores](https://knowledge.hubspot.com/pt/user-management/hubspot-user-permissions-guide#super-admin) 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*.
### Observação:
A HubSpot não armazena o corpo da solicitação, os parâmetros da URL da solicitação ou a carga útil da resposta de chamadas de API bem-sucedidas nos logs de aplicativos privados. Se você quiser rastrear esses dados ou armazenar dados de registro de mais de 30 dias atrás, é recomendável manter um registro externo das chamadas históricas do seu aplicativo.
* 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](/apps/legacy-apps/api-usage/usage-details). 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 do produto | Por 10 segundos | Por dia |
| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |
| Aplicativos privados | (Qualquer Hub)Gratuito e Starter | 100 / aplicativo privado | 250.000 / conta |
| | (Qualquer Hub) Profissional | 190 / aplicativo privado | 625.000 / conta |
| | (Qualquer Hub) Enterprise | 190 / aplicativo privado | 1.000.000 / conta |
| Aplicativos privados com [Aumento do limite de API](https://legal.hubspot.com/hubspot-product-and-services-catalog#Addons) | (Qualquer Hub)Grátis, Starter, Professional e Enterprise | 200 / aplicativo privado | 1.000.000 / conta sobre sua assinatura básica, para cada aumento de limite. Você pode comprar no máximo dois aumentos de limites de API. |
Se você tiver um plano Starter e Professional, os limites para o nível mais alto (Professional) se aplicam à sua conta.
Você pode enviar uma solicitação `GET` para `/account-info/v3/api-usage/daily/private-apps` para revisar o uso diário da API para todos os aplicativos privados em sua conta da HubSpot. Saiba mais sobre como usar a [API de informações da conta](/api-reference/account-account-info-v3/guide).
### Observação:
A compra de um Aumento de limite de API aumentará o número máximo de solicitações que você pode fazer à [API de associações](/api-reference/crm-associations-v4/guide) para 1.000 solicitações diárias e 200 solicitações a cada 10 segundos, mas esses limites não podem ser aumentados ainda mais com uma aquisição adicional de um Aumento de limite de API.
## 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 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**.