Zendesk連携インポート

ZendeskのFAQシステムからQANT Webにカテゴリ・アンサーを数クリックでインポートすることができます。 本記事では、インポートの仕組み・仕様を説明します。

Zendesk連携の仕組み

QANT Webのサーバーから、ZendeskのHelp Center APIというAPIを呼び出すことで、お客様のZendeskヘルプセンターのコンテンツを取得しています。 取得した情報は、QANT Webのカテゴリ・アンサーの形式に変換され、QANT Webに保存されます。

QANT Web・Zendesk間のカテゴリ・アンサーの対応関係

1. カテゴリ

Zendeskの「Category」「Section」の情報がQANT Webの「カテゴリ」に対応しています。 「Category」がQANT Webではトップレベルカテゴリになり、その下に「Section」がサブカテゴリとして階層構造でぶら下がっていく形となります。

各フィールドの対応関係は以下のようになります。

Zendesk Category	QANT Web カテゴリ
name	カテゴリ名
なし(Categoryには親が無いため)	親カテゴリID

 

Zendesk Section	QANT Web カテゴリ
name	カテゴリ名
parent_section_id (parent_section_idがnullの場合はcategory_id)	親カテゴリID

Zendesk CategoryおよびSectionのフィールド詳細については、下記をご参照ください。

• https://developer.zendesk.com/api-reference/help_center/help-center-api/categories/
• https://developer.zendesk.com/api-reference/help_center/help-center-api/sections/

2. アンサー

Zendeskの「Article」がQANT Webのアンサーに対応しています。 各フィールドの対応関係は以下のようになります。

Zendesk Article	QANT Web アンサー
title	タイトル
section_id	所属するカテゴリ
html_url	外部リンクURL
body	内容

Zendesk Articleのフィールド詳細については、下記をご参照ください。

• https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/

インポート時の注意点

• カテゴリのインポート→アンサーのインポートの順番で行ってください。
  • カテゴリがインポートされていない状態だと、アンサーをインポートすることはできません。
• zendesk側ではなくQANT Web側で新規でアンサーを作成後にインポートを実施した場合、アンサーの上書きはされません。

公開制限付きコンテンツのインポート

Zendeskでは、記事を特定のユーザー(例: サインインユーザー)限定で公開することができます。

このような記事のインポートを行うためには、インポート画面で、下記手順を実行してください。

1. 「公開制限付きコンテンツ」を「あり」に設定します。
2. 「認証方式」が表示される場合は、「OAuth」を選択します。
   • 「認証方式」が表示されない場合はそのまま3に進んでください。
3. Zendeskアカウントのサブドメインを入力します。
   • 例：URLが example.zendesk.com の場合は、exampleのみを入力してください。
4. 「認証」をクリックします。
5. Zendeskの認証画面で、公開制限付きコンテンツの閲覧権限を持つアカウントを使用してサインインし、連携を許可します。
6. QANT Webのインポート画面に戻り、「OAuth認証済み」と表示されていることを確認します。
7. 「インポート内容を確認」をクリックし、対象を確認してから「インポート実行」をクリックします。

これにより、OAuth認証を利用してZendeskのAPIを呼び出し、公開制限付きのセクション・記事もインポートできます。

なお、インポートされた記事は「停止中」のアンサーとしてQANT Webに作成され、そのままではサポートウィジェットやシナリオでの利用ができません。利用したい場合は、アンサー編集画面から、ステータスを「公開中」に変更してください(公開可能になった記事は、差分インポート時には公開中の状態が保たれます)。

また、OAuth認証の有効期限切れや、入力したサブドメインと認証済みのサブドメインが異なる場合は、インポート画面に案内が表示されます。画面の案内に従って「再認証」を行ってから、インポートをやり直してください。

⚠️ APIトークン認証方式をご利用中の方へ

Zendesk社の方針により、APIトークンによる認証は2027年4月30日に廃止されます。現在APIトークン認証を利用している場合は、2027年4月30日までに上記の手順でOAuth認証へ切り替えてください。詳細はZendesk社の案内をご覧ください。