Qualtrics API入門

Qualtrics APIについて

Qualtrics APIを使用して、クアルトリクス内の反復プロセスを自動化したり、クアルトリクスに情報を渡したり引き出したりできます。たとえば、ブランド管理者は、数百のアカウントを個別に作成するのではなく、Qualtrics 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と統合できます。

はじめに

パラメータの受け渡し

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

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

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 トークンを生成する

1. アカウントの右上隅にあるユーザ設定アイコンをクリックします。
   
2. ［アカウント設定］を選択します。
3. ナビゲーションバーの［クアルトリクスID］をクリックします。
   
4. APIというラベルのボックスで、［トークンを生成］をクリックします。

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

1. Qualtricsアカウントの右上隅にある［ユーザー設定］アイコンをクリックします。
   
2. ［アカウント設定］を選択します。
3. Qualtrics IDに移動します。
   
4. OAuth クライアントマネージャを選択します。
5. [クライアントの作成] をクリックします。
6. クライアント名を入力してください。
   
7. 必要に応じて、連絡先メールアドレスを入力します。
8. Grant Type には、Client Credentials を選択します。
9. [クライアントの作成] をクリックします。
10. クライアント ID とクライアントシークレットを書き留め、安全な場所に保存します。
    
    注意: このウィンドウを終了すると、クライアントシークレットは復元できなくなります。クライアントシークレットを失った、または忘れた場合は、上記のプロセスを繰り返して新しいシークレットを生成する必要があります。