PKSHA FAQ連携インポート

2023年11月14日更新

本機能は、RightSupportをご利用の一部のお客様にのみ開放しています。利用をご希望の場合はカスタマーサクセス担当にお問い合わせください。

PKSHA FAQ(旧OKBIZ. for FAQ)からRightSupportにカテゴリ・アンサーを数クリックでインポートすることができます。本記事では、インポートの仕組み・仕様を説明します。

PKSHA FAQ連携の仕組み

RightSupportのサーバーから、PKSHA FAQのAPIを呼び出すことで、お客様のPKSHA FAQのFAQサイトの情報を取得しています。取得した情報は、RightSupportのカテゴリ・アンサーの形式に変換され、RightSupportに保存されます。

連携の前提

連携にあたっては、下記の事前設定が必要となります。

お客さまのPKSHA FAQのAPIが有効化されていること
- 有料のPKSHA FAQ.APIオプションが必要です。
お客さまのPKSHA FAQのAPIが、KARTEの固定IPアドレスからのリクエストを受け付けられる状態になっていること
- IPアドレス制限をかけている場合は、上記IPアドレスを許可するように設定してください。

連携の注意点

初回インポート時

初めてアンサーのインポートを実行する際、RightSupportのサーバから、PKSHA FAQ側に登録されているFAQの数程度、FAQ取得のAPIがコールされます(例: 1000個FAQが存在する場合、APIがおおよそ1000回コールされる)。これに伴い、PKSHA FAQ側で一定程度のAPIの従量利用料金が発生する可能性があります。なお、二回目のアンサーインポート以降は、PKSHA FAQ側で更新があったFAQ記事に対してのみFAQ取得のAPIをコールしますので、APIコール回数はかなり抑えられます。

2回目以降インポート時

PKSHA FAQ側でFAQのステータスを非公開にした場合

RightSupport側の対応するアンサーは自動では非公開になりません。手動で、RightSupport側アンサーを非公開または削除にする対応をお願いいたします。

どのアンサーがPKSHA側で非公開になったかを自動検出することもできません。

PKSHA FAQ側でFAQに公開期限を設けた場合

インポート時点で公開期限を過ぎているアンサーに関しては、RightSupport側の対応するアンサーは非公開になります。

インポート時の注意

カテゴリのインポート→アンサーのインポートの順番で行ってください。

カテゴリがインポートされていない状態だと、アンサーをインポートすることはできません。

PKSHA FAQ側ではなくRightSupport側で新規でアンサーを作成後にインポートを実施した場合、アンサーの上書きはされません。

連携実行時の入力項目

連携時に必要な入力項目について説明します。

サイトID (文字列)
- PKSHA FAQのサイトIDを入力してください
マルチサイト情報から参照できるサイトID (整数)
- PKSHA FAQ管理画面のmyAdmin > 管理ダッシュボード > マルチサイト情報 > IDで参照できるIDです。上記の、文字列のサイトIDとは異なりますのでご注意ください。
クライアントID (文字列)
- APIの認証情報として用いるクライアントIDです。PKSHA FAQ管理画面の、myAdmin > コンテンツ > OAuth2.0設定で参照できます。
クライアントシークレット (文字列)
- APIの認証情報として用いるクライアントシークレットです。PKSHA FAQ管理画面の、myAdmin > コンテンツ > OAuth2.0設定で参照できます。
スマートフォン用回答 (チェックボックス、アンサーインポート時のみ)
- チェックを入れない場合: PKSHA FAQのFAQの「共通回答」がインポートされます。
- チェックを入れた場合: もしFAQに「スマートフォン用回答」が設定されていた場合、そちらがインポートされます。スマートフォン用回答がないFAQについては、共通回答がインポートされます。
FAQサイトのドメイン名 (文字列、アンサーインポート時のみ)
- PKSHA FAQのFAQサイトのドメイン名です。例えば、FAQ記事のURLがhttps://example.com/faq/show/4658だった場合、example.comの部分がドメイン名となります。
- 本ドメイン名は、インポートされたアンサーの「外部リンクURL」フィールドを構成する際に使われます。

RightSupport・PKSHA FAQ間のカテゴリ・アンサーの対応関係

1. カテゴリ

PKSHA FAQの「カテゴリー」がRightSupportの「カテゴリ」に対応しています。

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

PKSHA FAQ カテゴリー	RightSupport カテゴリ
name	カテゴリ名
parent_id	親カテゴリID

2. アンサー

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

PKSHA FAQ FAQ	RightSupport アンサー
question	タイトル
category	所属するカテゴリ
該当なし	外部リンクURL
answer (pcまたはsmartphone)	内容

外部リンクURLに関しては、PKSHA FAQ側のAPIレスポンスには対応するフィールドがありませんが、インポート時に入力するFAQサイトドメイン名、およびFAQのIDから、外部リンクURLが自動的に生成されます。