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

# APIs da HubSpot | Diretrizes de uso

> As diretrizes de utilização de APIs da HubSpot abrangem nossa Política de Uso Aceitável, Termos de API, limites de taxa, autenticação e segurança.

<RelatedApiLink />

A HubSpot monitora o uso de nossas APIs públicas para garantir uma experiência de qualidade para todos os usuários. Todos os desenvolvedores de apps e integrações devem cumprir a [Política de Utilização Responsável da HubSpot](https://legal.hubspot.com/acceptable-use) e os [Termos de APIs](https://legal.hubspot.com/hs-developer-terms). Embora a HubSpot se reserve o direito de alterar as APIs ou torná-las obsoletas ao longo do tempo, as atualizações sempre serão fornecidas por meio do [log de alterações do desenvolvedor](https://developers.hubspot.com/changelog).

## Autenticação e segurança

Para segurança ideal, todos os apps devem usar o [protocolo OAuth](/apps/legacy-apps/authentication/working-with-oauth) da HubSpot diretamente ou o token de acesso do app se você estiver criando um [app privado](/apps/legacy-apps/private-apps/overview). Os aplicativos são responsáveis por armazenar dados de tempo de vida (TTL) e atualizar os tokens de acesso do usuário de acordo com esse protocolo. Quando um token de acesso for gerado, ele incluirá um parâmetro `expires_in` que indica por quanto tempo ele poderá ser usado para fazer chamadas de API antes de precisar ser atualizado. As solicitações `Unauthorized (401)` não são um indicador válido de que um novo token de acesso deve ser recuperado.

## Verificando o uso da API

### Aplicativos privados

**Para visualizar o uso da API para um aplicativo privado:**

* Na sua conta da HubSpot, clique no **ícone de configurações** na barra de navegação principal.
* No menu lateral esquerdo, acesse **Integrações** > **Aplicativos privados**.
* Clique no **nome** do aplicativo privado.
* Na página de detalhes do aplicativo, clique na guia **Registros**.
* Revise as chamadas de API listadas na tabela. Você também pode usar **barra de pesquisa**, **filtros** e **seletores de datas** para refinar ainda mais as chamadas de API exibidas.

<Frame>
  <img src="https://www.hubspot.com/hubfs/Knowledge_Base_2023/Screenshot%202023-08-31%20at%205.28.03%20PM.png" alt="Captura de tela 2023-08-31 às 17:28:03" />
</Frame>

**Saiba mais sobre como [verificar o uso da API em aplicativos privados](/apps/legacy-apps/private-apps/overview).**

### Aplicativos públicos que usam OAuth

Para visualizar o uso da API para um aplicativo público usando OAuth:

* Na sua conta de desenvolvedor, acesse **Aplicativos** na barra de navegação principal.
* Clique no **nome** do aplicativo.
* No menu da barra lateral esquerda, acesse **Monitoramento**.
* Use as **guias** para visualizar diferentes tipos de solicitações feitas para ou por meio do aplicativo. Ao visualizar esses registros, você pode clicar em uma **solicitação individual** para visualizar mais informações.

<Frame>
  <img src="https://www.hubspot.com/hubfs/6-request_details.png" alt="6-request_details" />
</Frame>

Saiba mais sobre como [monitorar o uso da API para aplicativos públicos](/apps/legacy-apps/public-apps/overview#monitor-app-behavior).

## Limites de taxa

#### Aplicativos públicos

Para aplicativos OAuth, cada conta da HubSpot que instala o aplicativo está limitada a 110 solicitações a cada 10 segundos. Isso exclui a [API de pesquisa](https://br.developers.hubspot.com/docs/guides/api/crm/search), conforme observado na seção [Outros limites](#other-limits) abaixo. Limites relacionados com o [Aumento do limite da API](https://legal.hubspot.com/hubspot-product-and-services-catalog#Addons) não se aplicam.

#### Aplicativos privados

O número de chamadas que seu aplicativo privado pode fazer depende da assinatura da sua conta e se você comprou o [Aumento do limite da API](https://legal.hubspot.com/hubspot-product-and-services-catalog#Addons):

|                                                                                                                            | **Categoria do produto**                                         | **Por 10 segundos**      | **Por dia**                                                                                                                          |
| -------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
| Aplicativos privados                                                                                                       | (Qualquer Hub) <br /> Grátis e Starter                           | 100 / aplicativo privado | 250.000 / conta                                                                                                                      |
|                                                                                                                            | (Qualquer Hub) <br /> Professional                               | 190 / aplicativo privado | 625.000 / conta                                                                                                                      |
|                                                                                                                            | (Qualquer Hub) <br /> 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) <br /> Grátis, Starter, Professional e Enterprise | 250 / aplicativo privado | 1.000 / conta sobre sua assinatura básica, para cada aumento de limite. Você pode comprar no máximo dois aumentos de limites de API. |

<Warning>
  ### 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.000 solicitações diárias e 200 solicitações a cada 10 segundos, mas esses limites <u>não</u> podem ser aumentados ainda mais com uma aquisição adicional de um Aumento de limite de API.
</Warning>

## Outros limites

* Você pode criar até 100 apps por conta de desenvolvedor.
* Você pode criar até 20 apps privados por conta da HubSpot.
* Você pode criar até 1.000 assinaturas de webhook por app.
* Você pode criar até 25 configurações de extensão de CRM por app.
* Você pode criar até 750 tipos de evento de linha do tempo por app.
* Você pode criar até 500 propriedades por tipo de evento de linha do tempo.

## Limites de solicitação

Lembre-se dos seguintes limites gerais ao fazer solicitações aos pontos de extremidade da API do HubSpot. Algumas APIs também podem ter seus próprios limites específicos, que serão listados na página de referência da API em *Limites*.

<Frame>
  <img src="https://www.hubspot.com/hubfs/Knowledge_Base_2023_2024/single-send-limits-example.png" alt="single-send-limits-example" />
</Frame>

* A [API de pesquisa](https://br.developers.hubspot.com/docs/guides/api/crm/search) os pontos finais são limitados à taxa de <u>cinco</u> solicitações por segundo por token de autenticação e 200 registros por solicitação de página. Saiba mais sobre [limites de pesquisa](https://br.developers.hubspot.com/docs/guides/api/crm/search#limitations).
* As solicitações de API que estão isentas dos limites diários ou secundários <u>não</u> serão registrados no HubSpot. Se quiser armazenar estas solicitações isentas, você terá que as registrar externamente.
* As solicitações em lote para pontos de extremidade de objeto do CRM estão limitadas a 100 registros por solicitação. Por exemplo, você não pode ler em lote mais de 100 contatos por solicitação.

## Limites de serviço

Saiba mais sobre os limites e preços de serviços [aqui](https://legal.hubspot.com/hubspot-product-and-services-catalog).

## Respostas de erro

Qualquer aplicativo ou integração que exceda seus limites de taxa receberá uma resposta de erro `429` para todas as chamadas de API subsequentes. As solicitações que resultam em resposta de erro não devem exceder 5% das solicitações diárias. Se você planeja listar seu aplicativo no [Marketplace de aplicativos da HubSpot](https://ecosystem.hubspot.com/marketplace/apps), ele deverá estar abaixo desse limite de 5% para que seja certificado.

A resposta `429` terá o seguinte formato:

```json theme={null}
//Example
{
  "status": "error",
  "message": "You have reached your daily limit.",
  "errorType": "RATE_LIMIT",
  "correlationId": "c033cdaa-2c40-4a64-ae48-b4cec88dad24",
  "policyName": "DAILY",
  "requestId": "3d3e35b7-0dae-4b9f-a6e3-9c230cbcf8dd"
}
```

`message` E `policyName` indicarão o limite que você atingiu (diariamente ou por segundo).

O limite **diári** é redefinido meia-noite de acordo com sua[ configurações do fuso horário](https://knowledge.hubspot.com/account-management/change-your-language-and-region-settings).

A tabela a seguir detalha os cabeçalhos de limite de taxa incluídos na resposta de cada solicitação de API para o HubSpot, sujeito às exceções listadas abaixo da tabela.

| **Cabeçalho**                               | **Descrição**                                                                                                                                                                                                                                                                                     |
| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `X-HubSpot-RateLimit-Daily`                 | O número de solicitações de API permitidas por dia. Observe que este cabeçalho não está incluído na resposta a solicitações de API autorizadas usando [OAuth](/apps/legacy-apps/authentication/working-with-oauth).                                                                               |
| `X-HubSpot-RateLimit-Daily-Remaining`       | O número de solicitações de API ainda permitidas no dia atual. Observe que este cabeçalho não está incluído na resposta a solicitações de API autorizadas usando [OAuth](/apps/legacy-apps/authentication/working-with-oauth).                                                                    |
| `X-HubSpot-RateLimit-Interval-Milliseconds` | A janela de tempo à qual os cabeçalhos `X-HubSpot-RateLimit-Max` e `X-HubSpot-RateLimit-Remaining` se aplicam.Por exemplo, o valor 10.000 seria uma janela de 10 segundos.                                                                                                                        |
| `X-HubSpot-RateLimit-Max`                   | O número de solicitações permitidas na janela especificado em `X-HubSpot-RateLimit-Interval-Milliseconds`. Por exemplo, se o valor desse cabeçalho fosse 100 e o cabeçalho `X-HubSpot-RateLimit-Interval-Milliseconds` fosse 10.000, o limite aplicado seria de 100 solicitações por 10 segundos. |
| `X-HubSpot-RateLimit-Remaining`             | O número de solicitações de API ainda permitidas para a janela especificada em `X-HubSpot-RateLimit-Interval-Milliseconds`                                                                                                                                                                        |

<Warning>
  ### Observação:

  * Os cabeçalhos `X-HubSpot-RateLimit-Secondly` e `X-HubSpot-RateLimit-Secondly-Remaining` ainda estão incluídos e terão dados precisos, mas o limite ao qual eles fazem referência não será mais aplicado, por isso deverão ser considerados obsoletos.
  * As respostas dos [pontos de extremidade da API de pesquisa](https://br.developers.hubspot.com/docs/guides/api/crm/search) <u>não</u> incluirão nenhum dos cabeçalhos de limite de taxa listados acima.
</Warning>

Você também pode verificar o número de chamadas usadas durante o dia atual usando [este ponto de extremidade](/api-reference/account-account-info-v3/guide).

Se você se deparar com `TEN_SECONDLY_ROLLING`, acelere as solicitações que o aplicativo está fazendo para se manter abaixo desse limite. Confira as sugestões abaixo para acelerar as solicitações ou se você estiver atingindo o limite diário.

Se você perceber que, mesmo após ler essas sugestões, continua atingindo os limites de chamada, publique nos[ fóruns de desenvolvedores](https://integrate.hubspot.com/) da HubSpot. Você deve incluir o máximo de detalhes possível sobre as APIs que está usando, como elas estão sendo usadas e qual o limite atingido.

### Usar APIs em lote e resultados em cache quando possível

Se seu site ou aplicativo usar dados do HubSpot em cada carregamento de página, esses dados deverão ser armazenados no cache e carregados dele, em vez de serem solicitados todas as vezes nas APIs da HubSpot. Se você estiver fazendo chamadas repetidas para obter configurações sobre sua conta para um trabalho em lote (como obter as propriedades do objeto, os proprietários ou as configurações de um formulário), essas configurações também deverão armazenadas no cache sempre que possível.

### Usar webhooks para obter dados atualizados do HubSpot

Se tiver uma assinatura do HubSpot Operations Professional, você poderá usar ações de webhook em fluxos de trabalho para que os dados de registros de contatos sejam enviados para o seu sistema. Os webhooks podem ser disparados como uma ação em qualquer fluxo de trabalho. Dessa forma, é possível usar [condições iniciais](https://knowledge.hubspot.com/workflows/understand-contact-based-workflow-types) de qualquer fluxo de trabalho como os critérios para que os dados de contato sejam enviados para o sistema. Encontre [aqui](https://knowledge.hubspot.com/workflows/how-do-i-use-webhooks-with-hubspot-workflows) mais detalhes sobre como usar webhooks e [aqui](https://br.developers.hubspot.com/docs/reference/api/automation/create-manage-workflows/v3#create-a-workflow) um exemplo de dados de webhooks. As chamadas de webhook feitas por meio de fluxos de trabalho não contam para o limite de taxa da API.
