関連記事
アンサーをインポートする

※ 本機能は、RightSupportをご利用の一部のお客様にのみ開放しています。利用をご希望の場合はお問い合わせください。

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

OKBIZ.連携の仕組み

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

連携の前提

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

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

連携の注意点

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

連携実行時の入力項目

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

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

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

1. カテゴリ

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

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

OKBIZ. カテゴリー RightSupport カテゴリ
name カテゴリ名
parent_id 親カテゴリID

2. アンサー

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

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

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