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

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

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


設定

HubSpotとの連携を開発するには、いくつかの方法があります。

  • 例えば組織の他の部分との共有/統合用にアカウントの承認された部分のみを表示/編集できるアプリを開発する場合など、個別のHubSpotアカウント用の内部連携を開発するには、非公開アプリを作成します。
  • 複数のHubSpotアカウントにインストールできる公開アプリを作成する場合は、開発者アカウントを作成する必要があります。なぜなら、それぞれOAuthで認証され、設定可能な一連の機能と権限を備えたHubSpotアプリを作成する際には、開発者アカウントを使用するからです。また開発者アカウントでは、テストアカウントの作成や、アプリのステータスとパフォーマンスのモニタリング、HubSpotアプリマーケットプレイスへのアプリ公開も可能です。

さまざまな種類のアプリとアカウントの種類の詳細については、こちらの記事をご覧ください。

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

クライアントライブラリーは、HubSpot APIのスムーズな利用を目的に開発されています。さまざまな言語で記述され、アプリとHubSpot APIの間の仲介コードとして機能します。各APIコールのURLとHTTPメソッドを正確に覚えておく必要がなくなるため、アプリの作成作業に集中して取り組むことが可能になります。クライアントライブラリーの詳細は、こちらをご覧ください。

 

          言語

パッケージリンク

githubソースコード

iconfinder_nodejs-512_339733Node.Js

npm install @hubspot/api-client

hubspot-api-nodejs

new-php-logo

PHP

composer require hubspot/api-client

hubspot-api-php

ruby

Ruby

gem install hubspot-api-client

hubspot-api-ruby

iconfinder_267_Python_logo_4375050

Python

pip install hubspot-api-client

hubspot-api-python

 

APIドキュメント

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

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

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

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

連携ガイド

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

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

 

掲載

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

 

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

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

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

 

CMSでの構築

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


関連ドキュメント

HubSpot APIの使い方


参考になりましたか?
こちらのフォームではドキュメントに関するご意見をご提供ください。HubSpotがご提供しているヘルプはこちらでご確認ください。