メインコンテンツへスキップ
レッスン一覧に戻る

atom.cs-automator.zendesk-api-connect

Zendesk APIでデータを取得する

Zendesk APIでデータを取得する カスタマーサポートの現場では、「今日届いた問い合わせは何件?」「未対応のチケットはどれ?」といった情報を毎日確認しますよね。Zendesk の管理画面を開いてひとつずつ見る...

fetch-zendesk-tickets-via-apifetch-zendesk-tickets-via-api「fetch zendesk tickets via api」に関するスキルがこのレッスンで身につきます。
想定時間未設定公開状態: draft
学習メモ

成果物成果物このレッスンが終わったとき、あなたの手元に残る具体的な成果物です(例: 公開済みの Web ページ、動作するフォームなど)。

種類: markdown_doc検証: basic_manual_check_v1

証跡証跡成果物が正しく作れたことを確認するためのチェックリストです(例: ブラウザで動作する、フォーム送信で値が保存される)。

screenshotlog_output

メディアメディアレッスン内に出てくる図や動画のスロットです。実際の画面やイメージで理解を補助します。

diagramscreen_capture

レッスン本文

Zendesk APIでデータを取得する

カスタマーサポートの現場では、「今日届いた問い合わせは何件?」「未対応のチケットはどれ?」といった情報を毎日確認しますよね。Zendesk の管理画面を開いてひとつずつ見るのも良いですが、API(=ソフトウェア同士がデータをやり取りする窓口) を使えば、必要なデータをまとめて自動で取り出せるようになります。

たとえるなら、レストランで「メニューを見て自分で厨房に取りに行く」のではなく、「注文票を渡すとウェイターが料理を運んできてくれる」仕組みです。API は、あなたの代わりにデータを取ってきてくれるウェイターのような存在です。

この Atom では、AI チャット(Claude や ChatGPT)に手伝ってもらいながら、Zendesk API を使ってチケット一覧を取得するところまでを体験します。

API取得フロー


前提を確認する

始める前に、以下が揃っていることを確認してください。

  • Zendesk のアカウントがある(無料トライアルでもOK)
  • Zendesk の管理者権限、または API トークンを発行できる権限がある
  • AI チャットツール(Claude、ChatGPT など)が使える状態

ステップ1: API トークンを発行する

API を使うには、「この人は許可された利用者です」と証明するための**API トークン(=合い鍵のようなもの)**が必要です。

  1. Zendesk 管理画面にログインする
  2. 左メニューの 「管理センター」「アプリおよびインテグレーション」「Zendesk API」 を開く
  3. 「トークンアクセス」を有効にする(すでに有効ならそのまま)
  4. 「API トークンを追加」 をクリックし、わかりやすい名前(例: 「学習用トークン」)を付けて保存する
  5. 表示されたトークンを安全な場所にコピーして保存する(一度閉じると二度と表示されません)

API トークン発行画面

良い例: トークン名を「学習用トークン_20260413」のように日付付きで管理する

悪い例: トークンをチャットやメモ帳に貼りっぱなしにする(セキュリティ上危険です)


ステップ2: AI にリクエストの書き方を聞く

API を呼び出すには、決まった形式の「リクエスト(=お願いの文)」を送る必要があります。自分で一から書く必要はありません。AI に聞きましょう。

以下のプロンプトを AI チャットにコピペしてください。

Zendesk APIでチケット一覧を取得するcurlコマンドを教えてください。
以下の情報を使います:
- サブドメイン: example(←自分のZendeskサブドメインに置き換え)
- メールアドレス: user@example.com
- APIトークン: (ステップ1で取得したもの)
認証方式はAPIトークン認証で、最新5件だけ取得したいです。

AI が返してくれるコマンドは、おおよそ次のような形になります。

curl https://example.zendesk.com/api/v2/tickets.json?per_page=5 \
  -u user@example.com/token:YOUR_API_TOKEN

このコマンドの意味を日本語で説明すると:

  • curl → データを取りに行くための道具
  • https://example.zendesk.com/api/v2/tickets.json → チケットデータの受け取り窓口の住所
  • ?per_page=5 → 「5件だけください」という注文
  • -u ... → 「私はこの人です」という身分証明

ステップ3: 実際にデータを取得する

  1. パソコンのターミナル(Mac なら「ターミナル」アプリ、Windows なら「PowerShell」)を開く
  2. AI が生成してくれたコマンドの example 部分を自分のサブドメインに、メールアドレスとトークンを自分のものに書き換える
  3. コマンドを貼り付けて Enter を押す

成功すると、画面に JSON(=データの構造化された形式)が表示されます。"subject""status" といったチケット情報が含まれていれば成功です。

良い例: 結果に "tickets": [...] という配列が表示され、中にチケットの件名が見える

悪い例: "error": "Couldn't authenticate you" と表示される → トークンかメールアドレスが間違っています


ステップ4: 結果を確認して読み解く

取得した JSON データは一見すると読みにくいですが、AI に整理してもらえます。

以下のように、取得結果を AI チャットに貼り付けてみましょう。

以下はZendesk APIで取得したチケット一覧のJSONです。
このデータを見やすい表形式(件名・ステータス・作成日)に整理してください。

(ここにAPIの結果を貼り付ける)

AI が表形式で整理してくれるので、どんなチケットがあるかが一目で分かるようになります。


つまずきやすいポイント

症状原因対処法
Couldn't authenticate youメールアドレスまたはトークンの入力ミスコピペし直す。メールの後ろに /token: を忘れていないか確認
404 Not Foundサブドメインが間違っているブラウザで https://あなたのサブドメイン.zendesk.com にアクセスできるか確認
何も表示されないチケットが0件Zendesk 上にテスト用チケットを1件作ってから再実行
curl: command not foundcurl が入っていない(稀)AI に「自分のOSにcurlをインストールする方法」を聞く

完了を確認する

以下の2点ができていれば、この Atom は完了です。

  1. ターミナルで API を実行し、チケットデータの JSON が表示された(スクリーンショットを撮っておきましょう)
  2. 取得した JSON を AI に渡して、表形式に整理してもらえた

これで、Zendesk のデータを API 経由で取り出す基本操作ができるようになりました。次のステップでは、この取得したデータを使って自動レポートを作ったり、特定の条件でフィルタリングしたりする方法を学んでいきます。

成果物成果物このレッスンが終わったとき、あなたの手元に残る具体的な成果物です(例: 公開済みの Web ページ、動作するフォームなど)。

種類: markdown_doc

検証: basic_manual_check_v1

証跡とメディア

証跡証跡成果物が正しく作れたことを確認するためのチェックリストです(例: ブラウザで動作する、フォーム送信で値が保存される)。

screenshotlog_output

メディア

diagramscreen_capture
前提 atom

必須

なし

あると楽

なし

学習完了