Skip to main content
JavaScript SDK は npm で @profoundai/client として公開されています。TypeScript の型定義が同梱されています。

インストール

クイックスタート

Create a client and run a report

認証

SDK は、次のいずれかから API キーを読み込みます:
  1. 環境変数(推奨):環境に PROFOUND_API_KEY を設定します。
  2. コンストラクターのパラメーター:クライアントの初期化時に apiKey を渡します。
Set the environment variable
API キーの取得方法について詳しくは、認証 を参照してください。

エラー処理

Catch API errors

レート制限

API のデフォルトの制限は、API キーごとに 1 時間あたり 600 リクエストです。この制限を超えると、429 Too Many Requests エラーが返されます。SDK はエラーをスローするので、それをキャッチして処理できます。
Handle rate limits

非同期サポート

SDK は完全に async/await ベースです。すべてのメソッドは Promise を返します。
Await any method

コード例

API ドキュメントのすべてのエンドポイントには、動作する JavaScript のサンプルが含まれています。REST API & SDKs タブの Endpoints セクションで、次の内容を扱う例を参照できます:
  • 組織の管理
  • カテゴリーの検出
  • レポートの生成
  • 生データへのアクセス
API の改善に伴い、SDK のインターフェースが変更される場合があります。本番環境では特定のバージョンに固定してください。