HubSpotのAPIの使用を開始する

HubSpotの開発者プラットフォームは、さまざまな組織のスマートな成長(英語)を支援するという、HubSpotのミッションの中核を成しているとも言えます。HubSpot APIは、あらゆる形態やあらゆる規模のチームがカスタマイズを行ってHubSpotを最大限に活用できる、確かな連携の開発を可能にすることを目的として設計されています。

すべてのHubSpot APIはRESTを使って構築され、予測可能なURL構造で記述できるように設計されています。さまざまなメソッド(POSTGETPUTDELETE)やさまざまなエラー レスポンス コードを含め、標準的なHTTP機能が採用されています。HubSpot APIに対するすべての呼び出しは、https://api.hubapi.comで行われ、すべてのレスポンスとして標準的なJSONが返されます。


設定

HubSpotとの連携を始めるための近道は、開発者アカウントを作成することです。例えば、次のような理由が挙げられます。OAuthでの認証や、設定可能なさまざまな機能や権限を備えたHubSpotアプリを作成するための場になるのが、開発者アカウントです。また開発者アカウントでは、テストアカウントの作成や、アプリのステータスやパフォーマンスのモニタリング、HubSpotアプリマーケットプレイスへのアプリ公開もできます。

関連:開発者アカウントとテストアカウントの関係は?

クライアントライブラリー

すぐに開発に使えるライブラリーを主要な言語で提供しています。

# https://github.com/HubSpot/hubspot-api-nodejs
npm install @hubspot/api-client
 

APIドキュメント

HubSpotのAPIドキュメントは、リファレンスドキュメントと連携ガイドの2種類に分かれています。

リファレンスドキュメント

すべてのAPIリファレンスドキュメントは、概要とエンドポイントの項で構成されています。APIの概要には、機能の要約、使用例、連携に関する考慮事項が含まれています。エンドポイントの項には、各エンドポイント、パラメーター、複数言語によるリクエストの例が示されています。

開発者アカウントでアプリの認証設定を完了したら、エンドポイント リファレンス ページから直接Postmanを使用したり、テスト呼び出しを行ったりできます。 

連携ガイド

HubSpotのプラットフォームの基礎を学習したい場合、または初めてAPI呼び出しを行う前に例を見る場合は、連携ガイドの項でアプリやチュートリアルを検索したり、開発者アカウント、OAuthの利用、APIレート制限などの詳細を参照したりできます。 

関連:認証方式OAuthの詳細をご覧ください。

 

掲載

アプリを世界に配信するアプリパートナーになる準備ができたら、掲載認定に必要な条件を確認してください。その後、開発者アカウントでアプリマーケットプレイスへの掲載情報の作成と管理ができます。

 

サポートとコミュニティーのリソース

HubSpotの活発な開発者コミュニティーフォーラム(英語)とSlackコミュニティー(英語)に参加して、質問に答えてもらったり、交流したり、情報を共有したりしてみてください。当社は、こうしたフォーラムやコミュニティーに寄せられる貴重なご意見を、開発者エクスペリエンス向上の取り組みに役立てていきたいと考えています。

また、変更ログ(英語)の受信をお申込みいただくと、新機能、お知らせ、重要な変更などの最新情報をお届けします。

 

CMSでの構築

ウェブサイトの構築や、ブログ、ランディングページ、簡単なアプリ、Eメールの作成をお考えの場合は、CMS開発者ドキュメントをご覧ください。


関連ドキュメント

HubSpot APIの使い方