クアルトリクスAPI入門

クアルトリクス API について

Qualtrics APIを使用して、クアルトリクス内の反復プロセスを自動化したり、クアルトリクスに情報を渡したり引き出したりできます。たとえば、ブランド管理者は、数百のアカウントを個別に作成するのではなく、Qualtrics APIを使用してアカウント作成プロセスを自動化できます。同様に、ユーザーは手動で連絡先リストをまとめてインポートするのではなく、連絡先リストの作成を自動化できます。クアルトリクスには、ニーズに合わせて API を最大限に活用する方法を判断するのに役立つ、さまざまなAPI ソリューションガイドも用意されています。

注意: API拡張機能の実装には、プログラミングの知識が必要となる場合があります。クアルトリクスサポートチームでは、カスタムコーディングに関するサポートやコンサルティングは提供していません。その代わり、クアルトリクスXMコミュニティの経験豊富なユーザーにいつでも質問できます。クアルトリクスのカスタムコーディングサービスに関する詳細は、貴社のクアルトリクスアカウントエグゼクティブまでお問い合わせください。

さまざまな製品のAPIアクセス

クアルトリクスには、実用的なデータをリアルタイムで収集できるさまざまな製品があります。これらの製品には、アンケートプラットフォーム、サイトインターセプト、XM Directory (Target Audience) などが含まれます。Qualtrics API機能を購入すると、ライセンスに含まれるすべての製品でAPIを使用できるようになります。

各製品向けAPIの最新バージョンのドキュメントへのリンクは次のとおりです。

• ほとんどの製品の最新のAPIについては、クアルトリクスAPIを参照してください
• サイトのインターセプト

クアルトリクスは、常に最新バージョンのAPIの使用をお勧めしています。

Qualtrics v3 APIを理解する

クアルトリクス v3 APIは、シンプルなURL構文を使用してクアルトリクスシステムとの通信やクエリを可能にするREST API です。クアルトリクスシステムとの通信は、一連の要求と考えることができます。情報をクアルトリクスに送信、更新、削除、またはシステムに戻すよう要求できます。これらの要求は、JSON応答を返すGET、POST、PUT、DELETEのいずれかの要求によって作成できます。

これらの手段を通じてQualtrics APIを使用すると、クアルトリクスシステムの一部とやり取りし、これらの領域をご使用のCRMと統合できます。

はじめに

クアルトリクスAPIの利用開始に関する情報については、クアルトリクスAPIクイックスタートを参照してください。

パラメーターの受け渡し

パラメーターは、リクエストの構成要素です。各APIリクエストは、複数のグローバルパラメーターをクアルトリクスに渡す必要があります。また、リクエスト固有のパラメーターといくつかのオプションのパラメーターも必要です。

X-API-TOKENとして、リクエストのヘッダーを通じてAPIトークンを常に渡す必要があります。実行中の特定の要求に応じて、ヘッダー、URL、または要求の本文を介し、他のパラメーターを渡す必要がある場合があります。本体を介してパラメーターを渡す場合、パラメーターをJSON形式で送信する必要があります。この方法を使用する場合、Content-Type（application/jsonまたはmultipart/form-data）を指定する必要があります。

例：次のPOSTの例では、cURLでヘッダーにベースURL、Content-Type、およびトークンを指定します。エクスポートのアンケート ID と形式は本文で指定します。
curl -X POST -H 'X-API-TOKEN: yourapitokenhere' -H 'Content-Type: application/json' -d '{

"surveyId": "SV_012345678912345",

"format": "csv"

}' 'https://yourdatacenterid.qualtrics.com/API/v3/responseexports'

APIトークンの生成

Qualtrics APIにアクセスするには、APIトークンが必要です。ライセンス内の各ユーザーは、各自のAPIトークンを生成する必要があります。 作成した各APIリクエストを認証するには、アカウントのAPIトークンが必要です。トークンは、アカウントのパスワードの代わりに使用され、作業のセキュリティを強化するのに役立ちます。認証するには、HTTPS ヘッダー X-API-TOKEN にトークンを含めてください。

ヒント：トークンを生成するには、ユーザーのアカウントでAccess API権限が有効になっている必要があります。所属する組織でクアルトリクス API 機能をご利用いただけない場合は、クアルトリクスのアカウントエグゼクティブまで詳細をお問い合わせください。

APIトークンを生成するには

アカウントの右上隅にあるユーザー設定アイコンをクリックします。

---

×

close

アカウント設定を選択します。

ナビゲーションバーのクアルトリクスIDをクリックします。

---

×

close

注意: アカウント設定が再設計されました。クアルトリクスIDを表示するには、旧バージョンに切り替えるをクリックします。

---

×

close

APIというラベルの付いたボックスで、トークンを生成をクリックします。

警告: 既にトークンをお持ちの場合は、[トークンを生成] をクリックしないでください。APIトークンは一度だけ生成する必要があります。新しいトークンを生成すると、古いトークンを使用している既存の拡張機能が中断されます。新しいトークンの生成は元に戻せません。以前のトークンを取得することはできません。

クライアントシークレットの作成

クアルトリクスアカウントの右上隅にあるユーザー設定アイコンをクリックします。

---

×

close

アカウント設定を選択します。

クアルトリクス ID に移動します。

---

×

close

Attention: Account Settings has been redesigned. To view Qualtrics IDs, click Switch to older version.

---

×

close

OAuthクライアントマネージャーを選択します。

クライアントを作成をクリックします。

クライアント名を入力してください。

---

×

close

必要に応じて、連絡先のメールアドレスを入力します。

許可タイプには、クライアント認証情報を選択します。

クライアントを作成をクリックします。

クライアント ID と クライアントシークレット を書き留め、安全な場所に保管してください。

---

×

close

注意: このウィンドウを閉じると、クライアントシークレットは取得できなくなります。クライアントシークレットを紛失または忘れた場合は、上記の手順を繰り返して新しいクライアントシークレットを生成する必要があります。

ヒント：クアルトリクスIDの確認方法についての詳細は、クアルトリクスIDの確認をご覧ください。

モデルコンテキストプロトコル

モデルコンテキストプロトコル(MCP)は、AIアプリケーションを外部システムに接続するためのオープンソース標準です。多くの最新AIアプリケーション(ChatGPT、Claude、Cursorなど)は、MCPを活用してユーザーを支援しています。

クアルトリクスは、APIサイトに記載されている各API用のMCPサーバーを提供しています。各サーバーは、ここに記載されている API エンドポイント用の MCP ツールを公開しています。すべてのJSONベースのAPIに対応しています。現時点では、JSON以外のAPIはサポートされていません。

例えば、クアルトリクスMCPを使用して、クアルトリクスAPIで回答率を照会するAIエージェントを構築したり、クアルトリクスAPIでXM Directoryの顧客コンタクトを更新したりできます。 

この機能の活用方法に関する詳細は、APIサイトのMCPガイドをご覧ください。