> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.jp/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# HubSpot API | 利用ガイドライン

> HubSpotのAPI利用ガイドラインには、利用規定、APIに関する利用条件、レート制限、認証、セキュリティーに関する情報が網羅されています。

<RelatedApiLink />

HubSpotでは、全てのユーザーに安定した品質をお届けするために、公開APIの利用状況を詳しくモニタリングしています。アプリや連携の全ての開発に際し、[HubSpot利用規定](https://legal.hubspot.com/acceptable-use)と[APIに関する利用条件](https://legal.hubspot.com/hs-developer-terms)を順守していただく必要があります。HubSpotは随時APIを変更または廃止する権利を有しますが、更新情報は常に[開発者変更ログ](https://developers.hubspot.com/changelog)（英語）を通じて事前にお知らせします。

## 認証とセキュリティー

最適なセキュリティーを実現するために、全てのアプリにはHubSpotの[OAuthプロトコル](/apps/legacy-apps/authentication/working-with-oauth)を直接お使いいただく必要があります。または、[非公開アプリ](/apps/legacy-apps/private-apps/overview)を開発する場合にはアプリのアクセストークンを使用します。アプリには、このプロトコルに準拠したTTL（time-to-live）データの保存とユーザー アクセス トークンのリフレッシュを実装いただく必要があります。アクセストークンの生成時には、リフレッシュまでのAPI呼び出しに使用できる期間を示す`expires_in`パラメーターが含まれています。`Unauthorized (401)`（認証されていない）リクエストは、新しいアクセストークンを取得する必要があることを確実に示すものではありません。

## API利用状況の確認

### 非公開アプリ

**非公開アプリのAPIの使用状況を表示するには、次のようにします。**

* HubSpotアカウントにて、メイン ナビゲーション バーにある**設定アイコン**をクリックします。
* 左のサイドバーメニューで、**［連携］＞**［非公開アプリ］の順に進みます。
* 非公開アプリの**名前**をクリックします。
* アプリの詳細ページで、［ログ］タブをクリックします。
* 表に掲載されているAPI呼び出しを確認します。**検索バー**、**フィルター**、**日付入力**を使用して、表示されるAPI呼び出しをさらに絞り込むこともできます。

<Frame>
  <img src="https://www.hubspot.com/hubfs/Knowledge_Base_2023/Screenshot%202023-08-31%20at%205.28.03%20PM.png" alt="2023年8月31日午後5時28分03秒のスクリーンショット" />
</Frame>

**[非公開アプリでのAPIの使用状況の確認](/apps/legacy-apps/private-apps/overview)について詳しくは、こちらをご覧ください。**

### OAuthを使用した公開アプリ

OAuthを使用した公開アプリのAPIの使用状況を表示するには、次のようにします。

* 開発者アカウントで、メイン ナビゲーション バーにある［アプリ］に移動します。
* **アプリ名**をクリックします。
* 左のサイドバーメニューで［モニタリング］に移動します。
* **タブ**を切り替えることで、さまざまなタイプのアプリに対するリクエストやアプリからのリクエストを表示できます。これらのログが表示された状態で、**個々のリクエスト**をクリックすると、詳細情報が表示されます。

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

[公開アプリのAPI使用状況の監視](/apps/legacy-apps/public-apps/overview#monitor-app-behavior)の詳細をご確認ください。

## レート制限

#### 公開アプリ

OAuthアプリの場合、貴社のアプリをインストールするHubSpotアカウントごとに、リクエスト数は10秒間に110回までに制限されます。ただし、後述の[その他の制限](https://developers.hubspot.jp/docs/guides/api/crm/search)セクションで説明しているように、[検索API](#other-limits)は除きます。[API上限の引き上げ](https://legal.hubspot.com/hubspot-product-and-services-catalog#Addons)に関連する上限には該当しません。

#### 非公開アプリ

非公開アプリから実行できる呼び出しの回数は、アカウントのご契約内容と[API上限引き上げ](https://legal.hubspot.com/hubspot-product-and-services-catalog#Addons)のご購入状況に基づきます。

|                                                                                           | **製品のエディション**                                         | **10秒当たり**   | **1日当たり**                                                             |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------- | ------------ | --------------------------------------------------------------------- |
| 非公開アプリ                                                                                    | （全ての製品）<br />無料ツールおよびStarter                          | 100 / 非公開アプリ | 250,000 / アカウント                                                       |
|                                                                                           | （全ての製品）<br />Professional                             | 190 / 非公開アプリ | 625,000 / アカウント                                                       |
|                                                                                           | （全ての製品）<br />Enterprise                               | 190 / 非公開アプリ | 1,000,000 / アカウント                                                     |
| 非公開アプリ（[API上限引き上げ](https://legal.hubspot.com/hubspot-product-and-services-catalog#Addons) | あり）（全ての製品）<br />無料ツール、Starter、Professional、Enterprise | 250 / 非公開アプリ | 上限引き上げごとに1,000,000 / アカウント（基盤となるサブスクリプションに加えて）API上限引き上げは最大2つまで購入できます。 |

<Warning>
  ### 注:

  APIの上限数の引き上げを購入すると、[関連付けAPI](/api-reference/crm-associations-v4/guide)に対して実行できるリクエストの最大数が1日あたり1,000,000リクエスト、10秒あたり200リクエストに引き上げられます。ただしこれらの上限は、<u>API上限引き上げをさらに追加購入してこれ以上増やすことはできません</u>。
</Warning>

## その他の上限

* 開発者アカウント1件につき最大100件のアプリを作成可能
* HubSpotアカウント1件につき最大20件の非公開アプリを作成可能
* アプリ1件につき1,000件までのWebhook配信登録を作成可能
* アプリ1件につき最大25個のCRM拡張機能を作成可能
* アプリ1件につき最大750個のタイムライン イベント タイプを作成可能
* タイムライン イベント タイプ1個につき最大500個のプロパティーを作成可能

## リクエストの上限

HubSpot のAPIエンドポイントにリクエストを送信するときには、以下の一般的な制限事項に留意してください。一部のAPIには、より詳細な独自の制限が適用されていることがあります。これは、APIリファレンスページの制限\_\_に記載されます。

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

* [検索API](https://developers.hubspot.jp/docs/guides/api/crm/search)エンドポイントのレート制限: 認証トークン1つにつき1秒当たり最大5件のリクエスト、およびページリクエストごとに最大200件のレコード[検索の制限](https://developers.hubspot.jp/docs/guides/api/crm/search#limitations)の詳細をご確認ください。
* 日次上限または2次上限を免除されたAPIリクエストは、HubSpotのログに記録<u>されません</u>。免除対象のリクエストを保存するには、これらのリクエストを外部に記録する必要があります。
* CRMオブジェクトエンドポイントへの一括リクエストのレコード数の上限は、リクエストあたり100レコードです。例えば、1回の一括リクエストで、100件を超えるコンタクトを読み取ることはできません。

## サービスの制限

サービスの制限と価格については、[こちら](https://legal.hubspot.com/hubspot-product-and-services-catalog)をご覧ください。

## エラーレスポンス

アプリまたは連携がレート制限を超えると、以降の全てのAPI呼び出しに対し、`429`のエラーレスポンスを受け取ることになります。エラーレスポンスが返されるリクエストの数が、1日の合計リクエスト数の5％を超えないようにしてください。[HubSpotアプリマーケットプレイス](https://ecosystem.hubspot.com/marketplace/apps)へのアプリの掲載を予定している場合、この5％の上限を守っていただく必要があります。

`429`レスポンスの形式を以下に示します。

```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`と`policyName`は、どちらの上限に達したかを示します（日次上限または2次上限）。

**日次**上限は、[タイムゾーン設定](https://knowledge.hubspot.com/account-management/change-your-language-and-region-settings)に基づいて深夜0時にリセットされます。

次の表は、HubSpotへの各APIリクエストのレスポンスに含まれるレート制限ヘッダーの詳細を示しています。表の下部に例外が記載されています。

\| **ヘッダー** | **説明** |
\| --- | --- | --- |
\| `X-HubSpot-RateLimit-Daily` | 1日当たりに実行可能なAPIリクエストの数。このヘッダーは、[OAuth](/apps/legacy-apps/authentication/working-with-oauth)を使用して承認されたAPIリクエストへのレスポンスには含まれません。 |
\| `X-HubSpot-RateLimit-Daily-Remaining` | 当日に実行可能な残りのAPIリクエストの数。このヘッダーは、[OAuth](/apps/legacy-apps/authentication/working-with-oauth)を使用して承認されたAPIリクエストへのレスポンスには含まれません。 |
\| `X-HubSpot-RateLimit-Interval-Milliseconds` | `X-HubSpot-RateLimit-Max`ヘッダーと`X-HubSpot-RateLimit-Remaining`ヘッダーが適用される時間。例えば、値が10000なら10秒間を表します。 |
\| `X-HubSpot-RateLimit-Max` | `X-HubSpot-RateLimit-Interval-Milliseconds`に指定された時間内で実行可能なリクエストの数。例えば、このヘッダー値が100で、`X-HubSpot-RateLimit-Interval-Milliseconds`ヘッダーが10000の場合、リクエストの回数は10秒当たり100回に制限されます。 |
\| `X-HubSpot-RateLimit-Remaining` | `X-HubSpot-RateLimit-Interval-Milliseconds` | に指定された時間内で実行可能な残りのAPIリクエストの数。 |

<Warning>
  ### 注:

  * `X-HubSpot-RateLimit-Secondly`ヘッダーと`X-HubSpot-RateLimit-Secondly-Remaining`ヘッダーは現在も含まれ、そのデータ自体は正確ですが、この2つのヘッダーで参照されている上限は既に適用されていなくなったため、提供終了と捉えてください。
  * [検索APIエンドポイント](https://developers.hubspot.jp/docs/guides/api/crm/search)からのレスポンスに、上記のレート制限ヘッダーは<u>含まれません</u>。
</Warning>

[こちらのエンドポイント](/api-reference/account-account-info-v3/guide)を使って、当日中に使用された呼び出し数を確認することもできます。

`TEN_SECONDLY_ROLLING`の上限の到達が近づいている場合は、上限内に収まるように貴社のアプリから行うリクエストの数を調整してください。リクエストの調整と組み合わせる対策、または日次上限に達する場合の対策について、以下を参照してください。

これらの方法を試しても呼び出し上限に到達する場合は、HubSpotの[開発者フォーラム](https://integrate.hubspot.com/)に投稿してください。その際には、ご使用のAPIや、その利用状況、到達した上限など、できるだけ詳しい情報をご提供ください。

### 可能な限りバッチAPIとキャッシュ結果を使用する

サイトまたはアプリの各ページの読み込み時にHubSpotからのデータを使用する場合は、HubSpot APIで毎回リクエストするのではなく、データのキャッシュ処理によってキャッシュからデータを読み込むようにしてください。一括処理のためにアカウント設定を取得する呼び出しを繰り返し行う場合（オブジェクトのプロパティー、担当者、またはフォーム設定を取得するなど）、こうした設定情報についても可能な限りキャッシュ処理を行ってください。

### Webhookを使用してHubSpotから最新データを取得する

HubSpotのMarketing Hub Enterpriseをご契約されている場合、ワークフロー内でWebhookアクションを使用してコンタクトレコードのデータを貴社のシステムに送信できます。Webhookは、どのワークフローのアクションとしてもトリガーできるため、コンタクトデータを貴社のシステムに送信するための条件として、どのようなワークフローの[開始条件](https://knowledge.hubspot.com/workflows/understand-contact-based-workflow-types)でも使用できます。Webhookの詳しい使い方については、[こちら](https://knowledge.hubspot.com/workflows/how-do-i-use-webhooks-with-hubspot-workflows)を参照してください。また、Webhookデータの例については[こちら](https://developers.hubspot.jp/docs/reference/api/automation/create-manage-workflows/v3#create-a-workflow)をご覧ください。ワークフローを介して行われたWebhook呼び出しは、APIレート制限には計上されません。
