Contentsquare
こんにちは！お困りですか？
よく検索されるトピック: CS Live, 指標リスト, インテグレーションのリクエスト

最新情報: リリース & アップデート Contentsquare グロースプラン
English (GB) Français

このセクションの記事

  • 更新

API資格情報の作成方法

AIを使用して英語から翻訳されました

この記事はAI技術を使用して翻訳されたことにご注意ください。正確性を維持するよう努めていますが、一部の詳細は元のテキストを完全に反映していない場合があります。情報に不明な点がある場合は、英語版を参照してください。

OAuth認証情報を使用すると、Contentsquareの公開API（Metrics APIおよびRaw Data API）を認証できます。

これらの認証情報は、特定の認証エンドポイントに提供する必要があるペアで構成されています：client_idとclient_secret。

認証エンドポイントは、2つの重要な要素を返します：

  • 有効なJWTトークンは、Contentsquareの指標および生データエンドポイントをクエリするために使用されます。

  • すべてのContentsquare APIエンドポイントのベースURLは動的で、あなたのユニークなクラウドホスティング（AWS対Azureおよび地域）に依存します。

認証情報は、2つのレベルのいずれかで生成できます：

  • アカウントレベルでは、認証情報が生成されたアカウントに関連付けられた任意のプロジェクトのリソースを要求できます。

  • プロジェクトレベルでは、認証情報が生成された特定のプロジェクトのリソースのみを要求できます。

APIキーは非推奨になりました

Contentsquareは2023年にAPIキーを非推奨にしました。APIキーはAPIにアクセスするために使用される静的な認証情報でした。2024年4月30日以降、APIキーを使用しているアプリケーションは動作を停止します。これには以下が含まれます：

  • 生データおよび指標API
  • Looker Studioコネクタ
  • Qualtrics拡張（埋め込みセッションリプレイプレイヤー）
  • J+Report（Reeport）
  • Dexem

継続的なアクセスを確保するためには、OAuth認証情報に移行する必要があります。OAuthは、client_idおよびclient_secretに関連付けられた短命のアクセストークンを発行することにより、より強力なセキュリティを提供し、より良い制御とユーザー認証を可能にします。
既存のAPIキーを置き換えるための移行手順に従ってください。

認証情報の作成方法

1. 'コンソール'に移動します。

Screenshot 2024-05-23 at 13.22.10.png


2. アカウントまたはプロジェクトレベルを選択し、'API認証情報'タブに移動し、次に'アカウント認証情報を作成'をクリックします。

  • アカウント全体のすべてのプロジェクトにアクセスできる資格情報が必要か、特定のプロジェクトのみの資格情報が必要かに基づいて、アカウントレベルまたはプロジェクトレベルを選択します。
  • アカウントレベルとプロジェクトレベルの両方に同じ 'API Credentials'タブがあります。
    • プロジェクトレベルの場合： プロジェクトに移動 > 'API credential'タブ > 'Create account credentials'
    • アカウントレベルの場合： アカウントに移動 > 'API credential'タブ > 'Create account credentials'

API

  • すでに資格情報が作成されている場合、'Create account credentials'ボタンは資格情報リストの右上隅に表示されます。

API

注：アカウントごとおよびプロジェクトごとに最大10のAPI資格情報を作成できます。

3. OAuth資格情報情報を入力します：資格情報の名前とそれを使用できるIPのリスト（デフォルトでは任意のIP）を入力し、'Create account/ project credentials'をクリックします。

API

  • 特定のIPのホワイトリストを提供する必要がある場合は、'Allow specific IP addresses'を選択し、ホワイトリストに追加したいすべてのIPをリストします（IPv4またはIPv6形式のいずれか）そして'Create account/ project credentials'をクリックします。

API

4. 生成されたOAuth資格情報が表示されるポップアップが表示されます。資格情報を安全な場所に保管してください。これが表示される最後の機会であり、Contentsquareはセキュリティ上の理由からそれらを保存しません。'I copied my credentials'をクリックします。

I

注：セキュリティ上の理由から、Contentsquareは資格情報を保存せず、このポップアップで一度だけ表示します。

5. API資格情報タブビューにリダイレクトされ、新しい資格情報がリストされます。これらの資格情報を使用してContentsquareの公開APIをクエリできます。

Screenshot

OAuth資格情報を再生成する方法

1. 'Console'に移動 > 'API Credentials'タブ >'...'その他のオプションメニュー > 'Regenerate credentials'

REGENERATE

2. 確認メッセージのプロンプトを読み、'Regenerate credentials'をクリックします。

REGNERATE

3. 新しい認証情報がポップアップに表示されますので、それを使用して既存の認証情報を更新してください。再生成された認証情報は、その接続の以前の認証情報を無効にします。

  • client_secretをコピーして保存してください。再度表示したり、後で回復したりすることはできませんので、'認証情報をコピーしました'をクリックしてください。

REGENERATE

OAuth認証情報の編集方法

1. 'コンソール' > 'API認証情報'タブ > '...' その他のオプションメニュー > '認証情報を編集'に移動します。

EDIT

2. 認証情報の構成フォームが開きます。名前、説明、ホワイトリストに登録されたIPのリストを編集し、'アカウント認証情報を編集'をクリックして保存します。

EDIT

注: エディションを確認すると、新しい認証情報は生成されません。作成時に生成された同じ認証情報を引き続き使用できます。

認証情報を取り消す方法

1. 'コンソール' > 'API認証情報'タブ > '...' その他のオプションメニュー > '認証情報を取り消す'に移動します。

REVOKE

2. 使用中の認証情報を取り消すとアプリケーションが中断される可能性があることを思い出させるポップイン確認メッセージを読みます。'認証情報を取り消す'をクリックします。

REVOKE

3. あなたの認証情報は認証情報のリストから削除され、Contentsquareの公開APIをクエリするために再度使用することはできません。