日本円決済でお得にZendeskを導入7年以上のサポート実績をもつZeQ(ゼクー)にお任せください
詳しくはこちら

Zendesk Guideカスタマイズ|ヘルプセンターAPIを叩いてみた

Zendeskについて

Zendeskとは

Zendeskはチャット、ール、チケット、レポート、ヘルプセンター(FAQサイト)構築など様々なカスタマーヘルプ支援サービスを提供するクラウド型のソフトウェアです。

Zendesk Guideとは

Zendesk Guideはヘルプセンター(FAQサイト)を簡単に構築できるZendeskの代表的な機能(製品)の一つです。フォーマットも何種類か用意されているため、おしゃれな雰囲気のFAQサイトが簡単に作成できます。イメージとしてはよくある質問とその回答の記載、インシデントとその対策などが記載されているようなページで差し支えないと思います。

セクションを作成することができので、FAQやインシデント対応など様々なカテゴリに分類し、記事を作成できます。

ヘルプセンターAPIについて

Zendeskでは独自のカスタマイズや外部システムと連携するために様々なAPIが用意されています。この記事ではGuide機能に搭載されるヘルプセンターや、ナレッジベースの機能拡張のために用意されたヘルプセンターAPIについてコマンドで実行してみようと思います。

API使用までの準備

Zendeskアカウントを発行
Zendeskを使用するためには、まずZendeskアカウントの発行が必要となります。

ユーザ登録は他のサービスでもよくあるように個人情報を入力して登録すると、メールアドレスに認証メールがくるので、そこにアクセスすればZendeskへの登録完了となります。

こちら(Zendesk公式サイトから登録を行うと、通常即日アカウントが発行されます。

※Zendeskは有料ですが、試用期間(トライアル)として2週間無料で使用することができ流ので、まずどんなことができるのかを試すことができます。

ヘルプセンターにアクセス

以下キャプチャのようにTopページの右上の4つの四角のマークから「Guide(ヘルプセンターの活用)」の項目をクリックします。

クリックすると以下のヘルプセンターのページにアクセスできます。左上の「追加」をクリックすると項目が表示されるので、「記事」をクリックします。

※「追加」からカテゴリを作成すると画面下の「testカテゴリ、test category1」となっている項目が追加されていきます。

※「追加」からセクションを作成しておいたほうが、API確認に確認しやすくなります。

 

記事作成

以下キャプチャのように記事の題名と内容を記載しセクションを選択、右上の保存の右側の「 ^ 」をクリック、ドロップダウンで表示された項目の「公開」をクリックすると記事が作成されます。

※本記事の内容を再現する場合、こちらで記事を10記事以上作成した方が理解しやすいと思います。内容は適当で問題ありません。

ラベルは必須ではないですが指定した方が、後々の確認で確認しやすくなります。ラベルは任意の値をテキストボックスに入力し登録することが可能です。

API実行

それではいよいよ以下のzendesk developpersの公式APIリファレンスのページに記載されているヘルプセンターのAPIについて実施していこうと思います。

※デフォルトは英語となっています。

・APIリファレンスURL

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

ヘルプセンターの記事をまとめて表示

参考URL:https://developer.zendesk.com/api-reference/help_center/help-center-api/introduction/

コマンド(ブラウザで以下のURLにアクセス):https://{subdomain}.zendesk.com/api/v2/help_center/articles.json?page[size]=10

※「page[size]=10」に指定する値の記事を返却しますので、

 上記コマンドでは10件の記事を表示します。指定できる最大値は100となります。

実際にコマンド実行(ブラウザに上記コマンドを入力)すると、以下のように画面上に返却があります。

linksのnextのURLにアクセスすると、次の10件の記事を表示、

lastのURLにアクセスすると、最後の10件の記事を表示できます。

articleの中身が記事の詳細となります。

最大値である100記事を指定する場合は、以下のコマンドを実行します。

コマンド:

https://{subdmain}.zendesk.com/hc/api/v2/articles.json?page%5Bsize%5D=100

実際にコマンド実行(ブラウザに上記コマンドを入力)すると、以下のように画面上に返却があります。記事の全量が100記事存在しないため、linksのnextが存在しないことがわかります。

ヘルプセンターの記事の単体を表示

参考URL:https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/#update-article

コマンド(ブラウザで以下のURLにアクセス):

https://{subdomain}.zendesk.com/api/v2/help_center/articles/{article_id}.json

記事IDを指定することで、以下のように記事単体の値が画面上に返却されます。先ほど「ヘルプセンターの記事をまとめて表示」のキャプチャで表示した記事のID「4405781755151」を指定して、記事単体を取得してみます。

ロケールでの検索

デフォルトでは、検索はヘルプセンターの設定で指定されたデフォルトの言語で実行されます。このlocaleパラメーターを使用して、別の言語の記事を検索します。

参考URL:https://developer.zendesk.com/api-reference/help_center/help-center-api/search/

コマンド(ブラウザで以下のURLにアクセス):

https://{subdomain}.zendesk.com/api/v2/help_center/ja/articles.json

以下の内容から、記事は22件(countが22)あり、次のページ(next_pageがnull)はなく、ページ量(pageが1)は1ページ、1ページには30記事(per_pageが30)が表示されることがわかります。

※有効なロケールとデフォルトのロケールを一覧表示については以下で確認できます。以下の例からは有効なロケール、デフォルトのロケール共に「ja」のみということがわかります。

参考:https://developer.zendesk.com/api-reference/help_center/help-center-api/translations/#list-enabled-locales-and-default-locale

コマンド(ブラウザで以下のURLにアクセス):

https://{subdomain}.zendesk.com/api/v2/help_center/locales

日付での検索

参考URL:

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

コマンド(ブラウザで以下のURLにアクセス):

https://{subdomain}.zendesk.com/api/v2/help_center/articles/search.json?query=“検索文字”&updated_after=YYYY-MM-DD&updated_before=YYYY-MM-DD

※YYYYMMDDには任意の日付を入力します。

※検索文字には任意の文字を入力します。

実際にコマンド実行(ブラウザに上記コマンドを入力)すると、以下のように画面上に返却があります。

以下コマンドを実行した例となります。

(検索文字に「APIテスト」2021-08-01から2021-08-31に更新された記事を検索する例となります。)

https://{subdomain}.zendesk.com/api/v2/help_center/articles/search.json?“APIテスト”&updated_after=2021-08-01&updated_before=2021-08-31

ラベルでの検索

ラベルを指定し記事を検索することができます。

「API使用までの準備」でつけたラベルを指定し、特定の記事が取得できることを確認できます。

参考URL:https://developer.zendesk.com/api-reference/help_center/help-center-api/search/

コマンド(ブラウザで以下のURLにアクセス):

https://{subdomain}.zendesk.com/api/v2/help_center/articles/search.json?label_names=ラベル名

実際にコマンド実行(ブラウザに上記コマンドを入力)すると、以下のように画面上に返却があります。

以下コマンドを実行した例となります。

(ラベル名に「テストラベル1」がついている記事を検索する例となります。)

https://{subdomain}.zendesk.com/api/v2/help_center/articles/search.json?label_names=テストラベル1

セクションでの検索

ラベルを指定し記事を検索することができます。

「API使用までの準備」でつけたセクションを指定し、特定の記事が取得できることを確認できます。

参考URL:https://developer.zendesk.com/api-reference/help_center/help-center-api/search/

コマンド(ブラウザで以下のURLにアクセス):

https://{subdomain}.zendesk.com/api/v2/help_center/articles/search.json?query=検索文字&section=セクションID

※検索文字には任意の文字を入力します。

実際にコマンド実行(ブラウザに上記コマンドを入力)すると、以下のように画面上に返却があります。

以下コマンドを実行した例となります。

(検索文字に「test」、セクションIDが「4405756030863」がついている記事を検索する例となります。)

https://{subdomain}.zendesk.com/api/vv2/help_center/articles/search.json?query=”test”&section=4405756030863

※セクションの確認方法については、「ヘルプセンターの記事をまとめて表示」で確認しましょう。

関連記事

Zendeskにはヘルプセンター以外のAPIも様々存在します。

開発検証しているので、よろしければ読んでみて下さい。

ZendeskのWebWidgetAPIを叩いてみた

 

その悩み、7年以上のサポート実績をもつZeQ(ゼクー)にお任せください!

ご興味を持たれた方は、気軽にご相談ください。

お問い合わせ
執筆者:ZeQ
ZeQは国内で最も歴史がある、Zendesk公認マスターパートナーです。
Zendesk導入支援450社以上の経験から、お客様の運用に合わせてお困りごとを解決し、Zendeskの導入から定着まで、ワンストップでサポートしています。