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

クライアントライブラリーは、HubSpot APIのスムーズな利用を目的に開発されています。さまざまな言語で記述され、アプリとHubSpot APIの間の仲介コードとして機能します。各API呼び出しのURLやHTTPメソッドなどを調べたり確認したりする労力が省けるため、アプリの作成作業に集中して取り組むことが可能になります。

HubSpotアプリケーションを駆動するソースコードをはじめ、HubSpotはオープンAPI(英語)形式を使用して、APIを説明するドキュメントを生成します。これらのドキュメントはオープンAPIコード生成ツール(英語)に取り込まれ、生成されたファイルがライブラリーに追加されますが、それで終わりではありません。HubSpotの開発者チームは、このコード生成による出力をさらに価値あるものにするために、レート制限に役立つユーティリティー関数や、実際にライブラリーを使用する方法を示す多数のサンプルアプリケーションを追加しています。これらの例は幅広いユースケースをカバーしているので、必ずご活用ください。

以下のエンドポイントを使用して、利用可能なオープンAPIの仕様にアクセスできます。

GET: https://api.hubspot.com/api-catalog-public/v1/apis

 

          言語

パッケージリンク

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

試してみる

これらのクライアントライブラリーの使用を開始するには、標準アカウントまたはアプリ開発者アカウントのいずれかのHubSpotアカウントが必要です。クライアントライブラリーを使用して非公開アプリを作成すると、その非公開アプリのトークンで呼び出しを認証できるようになります。また、HubSpot開発者アカウントを作成し、OAuthを使用して呼び出しを認証することもできます。

HubSpotアカウントと非公開アプリのアクセストークンまたはOAuthトークンを取得したら、ライブラリーをインストールできます。以下の例では、Node.jsクライアントをインストールし、クライアントをインスタンス化して使用する一般的な方法を示しています。

インストール 

npm install @hubspot/api-client

クライアントのインスタンス化

//Authenticate via private app access token stored as a secret const hubspot = require('@hubspot/api-client') const hubspotClient = new hubspot.Client({ accessToken: process.env.secretName }) //Or via OAuth const hubspotClient = new hubspot.Client({ accessToken: YOUR_ACCESS_TOKEN })

使用法

//Example call hubspotClient.crm.contacts.basicApi .getPage(limit, after, properties, associations, archived) .then((results) => { console.log(results.body) }) .catch((err) => { console.error(err) })

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