Qualtrics Platform
Customer Journey Optimizer
XM Discover
Qualtrics Social Connect

Qualtrics API入門

Qualtrics APIについて

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

注意: API 拡張を実装するには、プログラミングの知識が必要な場合があります。クアルトリクスサポートチームでは、カスタムコーディングに関するサポートやコンサルティングは提供していません。ただし、コミュニティの経験豊かなユーザー（英語）に尋ねてみることは可能です。カスタムコーディングサービスの詳細については、クアルトリクスの営業担当にお問い合わせください。

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

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

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

ほとんどの製品の最新の API については、Qualtrics API を参照してください。
Site Intercept

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

Qualtrics v3 APIを理解する

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

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

はじめに

Qualtrics APIの開始方法については、Qualtrics APIクイックスタートを参照してください。

パラメータの受け渡し

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

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

例: 次の POST 例では、cURL で Base URL、Content-Type、および Token をヘッダに指定します。サーベイ ID およびエクスポート形式は、
body.curl -X POST -H 'X-API-TOKEN' -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 にトークンを含めます。

ヒント：トークンを生成するには、ユーザーは自分のアカウントで［APIにアクセス］権限を有効にしておく必要があります。組織にQualtrics API機能へのアクセス権がない場合は、詳細についてクアルトリクスの営業担当にお問い合わせください。

API トークンを生成する

アカウントの右上隅にあるユーザ設定アイコンをクリックします。
［アカウント設定］を選択します。
ナビゲーションバーの［クアルトリクスID］をクリックします。

注意: アカウント設定が再設計されました。クアルトリクスIDを表示するには、［旧バージョンに切り替え］をクリックします。
APIというラベルのボックスで、［トークンを生成］をクリックします。

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

クライアントシークレットの登録

Qualtricsアカウントの右上隅にある［ユーザー設定］アイコンをクリックします。
［アカウント設定］を選択します。
Qualtrics IDに移動します。

注意: アカウント設定が再設計されました。クアルトリクスIDを表示するには、［旧バージョンに切り替え］をクリックします。
OAuth クライアントマネージャを選択します。
[クライアントの作成] をクリックします。
クライアント名を入力してください。
必要に応じて、連絡先メールアドレスを入力します。
Grant Type には、Client Credentials を選択します。
[クライアントの作成] をクリックします。
クライアント ID とクライアントシークレットを書き留め、安全な場所に保存します。

注意: このウィンドウを終了すると、クライアントシークレットは復元できなくなります。クライアントシークレットを失った、または忘れた場合は、上記のプロセスを繰り返して新しいシークレットを生成する必要があります。