チケットの作成を自動化したり、カスタムレポートのデータを取得したり、Zendeskを他のツールと統合したいと思ったことはありませんか？ Zendesk APIを使用すれば、それが可能になります。 これは、Zendeskと他のテックスタックとの間の架け橋です。
しかし、どこから始めればよいのでしょうか？ ドキュメントは包括的であり、何を探しているのかがわかれば素晴らしいことです。 最初にどのアンドポイントを呼び出すべきか分からず、空白のターミナルを見つめているときは、それほど素晴らしいことではありません。
このガイドでは、Zendesk APIとは何か、認証方法、最もよく使用するコアエンドポイント、および開始するためのいくつかの実践的な例について説明します。
Zendesk APIとは？
APIをレストランのウェイターのように考えてください。 テーブル（アプリケーション）に座って、料理（データまたはアクションのリクエスト）を注文します。 ウェイターは、その注文をキッチン（Zendeskのサーバー）に運び、食事（レスポンス）を持ち帰ります。 APIは、交換を可能にするメッセンジャーです。
Zendesk APIは、すべてのデータ交換にJSONを使用するREST APIです。 標準のREST規則に従います。GETを使用してデータを取得し、POSTを使用して作成し、PUTを使用して更新し、DELETEを使用して削除します。 APIを使用すると、チケット、ユーザー、組織、ヘルプセンターのコンテンツなどにプログラムでアクセスできます。
Webインターフェースの代わりにAPIを使用する理由は何ですか？ いくつかのシナリオが考えられます。
- 一括操作：UIを1つずつクリックする代わりに、一度に100件のチケットを作成します。
- データエクスポート：チケットデータを独自のレポートツールまたはデータウェアハウスにプルします。
- 統合：ZendeskをCRM、内部ツール、またはカスタムアプリケーションに接続します。
- 自動化：他のシステムのイベントに基づいてZendeskでアクションをトリガーします。
コードを書かずに自動化したいチームには、代替手段があります。 私たちはeesel AIを構築し、API統合作業なしで、Zendesk内でAIチームメイトとして機能し、チケットを自律的に処理できるようにしました。 ただし、カスタム機能が必要な場合は、APIを使用する必要があります。
Zendesk API認証の開始
API呼び出しを行う前に、認証する必要があります。 Zendeskは、APIトークンとOAuthの2つの主要な方法を提供しています。
APIトークン認証
APIトークンは、開始するための最も簡単な方法です。 これらは、Zendesk管理センターのアプリと統合 > API > Zendesk APIで作成する自動生成されたパスワードです。
知っておくべきことは次のとおりです。
- アカウントごとに最大256個のアクティブなトークンを持つことができます。
- トークンはパスワードとして機能し、管理者を含む任意のユーザーを偽装できます。
- 認証には
{email_address}/token:{api_token}の形式を使用します。
APIトークンを使用したcurlリクエストは次のようになります。
curl https://your-subdomain.zendesk.com/api/v2/tickets.json \
-u jdoe@example.com/token:6wiIBWbGkBMo1mRDMuVwkw1EPsNkeUj95PIz2akv
OAuthアクセストークン
OAuthは、複数のZendesk顧客向けのアプリを構築する場合、またはブラウザからクライアント側のAPIリクエストを行う必要がある場合に適しています。 OAuthトークンは、単一のZendeskインスタンスにスコープされ、Bearerトークン形式を使用します。
Authorization: Bearer gErypPlm4dOVgGRvA1ZzMH5MQ3nLo8bo
複数の顧客にアプリを配布する場合は、グローバルOAuthトークンを使用する必要があります。 Zendeskは顧客が第三者と資格情報を共有することを禁止しているため、通常のAPIトークンは機能しません。
レート制限
すべてのAPIリクエストはレート制限の対象となります。 制限を超えると、待機時間を示すRetry-Afterヘッダーとともに、429 Too Many Requestsレスポンスが返されます。
レスポンスヘッダーには、現在のレート制限ステータスが含まれています。
X-Rate-Limit: 700
X-Rate-Limit-Remaining: 699
ソース：Zendeskレート制限
コアZendesk APIエンドポイントとその機能
Zendesk APIは、チケット、ユーザー、組織などのリソースを中心に構成されています。 最も頻繁に使用するエンドポイントを次に示します。
チケットAPI
チケットAPIは、ほとんどの時間を費やす場所です。 コアサポート機能を処理します。
主なエンドポイント：
GET /api/v2/tickets.json- チケットを一覧表示します（ページネーション、1ページあたり100件）。POST /api/v2/tickets.json- 新しいチケットを作成します。GET /api/v2/tickets/{id}.json- 特定のチケットを取得します。PUT /api/v2/tickets/{id}.json- チケットを更新します。DELETE /api/v2/tickets/{id}.json- チケットを削除します。
一括操作を使用すると、一度に最大100件のチケットを操作できます。 これは、大量の更新またはインポートに役立ちます。 APIは、チケット作成のべき等キーもサポートしています。これにより、失敗したリクエストを再試行する必要がある場合に、チケットの重複を防ぐことができます。
ソース：ZendeskチケットAPI
ユーザーおよび組織API
顧客データの管理は、ユーザーおよび組織APIを通じて行われます。
主なエンドポイント：
GET /api/v2/users.json- すべてのユーザーを一覧表示します。POST /api/v2/users.json- ユーザーを作成します。GET /api/v2/organizations.json- 組織を一覧表示します。POST /api/v2/organizations.json- 組織を作成します。
APIを使用すると、1つのリクエストで最大100個の組織を作成できます。 一度に1つしか作成できないUIと比較してください。 別のシステムから移行する場合、APIを使用すると時間が節約されます。
検索API
検索APIは、Zendesk APIで最も強力なツールの1つです。 Zendesk Webインターフェースと同じクエリ構文を使用して、チケット、ユーザー、組織、およびグループを検索できます。
エンドポイントは簡単です。
GET /api/v2/search?query={query}
ただし、クエリ構文は強力です。 次の条件で検索できます。
- チケットステータス：
type:ticket status:open - タグ：
tags:escalation_one,escalation_two - 日付範囲：
created>2024-01-01 - カスタムフィールド：
custom_field_123:priority
UIに対する1つの重要な利点：検索APIにはアーカイブされたチケットが含まれています。 Zendeskビューは120日後にアーカイブされたチケットを除外しますが、API検索はすべてを検索します。
検索APIには、1分あたり2,500リクエストの独自のレート制限があり、クエリあたり最大1,000件の結果を返します。 より大きなデータセットの場合は、カーソルベースのページネーションでエクスポート検索結果エンドポイントを使用します。
ソース：Zendesk検索API
ヘルプセンターAPI
ナレッジベースにZendesk Guideを使用している場合、ヘルプセンターAPIを使用すると、記事、カテゴリ、およびコミュニティ投稿をプログラムで管理できます。 コンテンツを作成したり、翻訳を管理したり（上位プランでは40以上の言語がサポートされています）、記事の権限を制御したりできます。
実践的なZendesk APIの例
独自のユースケースに合わせて調整できる実際の例を見てみましょう。
curlでチケットを作成する
チケットを作成する完全な例を次に示します。
curl https://your-subdomain.zendesk.com/api/v2/tickets.json \
-d '{"ticket": {"subject": "Printer offline", "comment": { "body": "My printer is offline. Restarting doesn't help." }}}' \
-H "Content-Type: application/json" \
-v -u jdoe@example.com/token:YOUR_API_TOKEN -X POST
これを分解すると：
-dフラグは、チケットの件名とコメントを含むJSONペイロードを送信します。Content-Type: application/jsonは、JSONを送信していることをZendeskに伝えます。-uは、認証資格情報を提供します。-X POSTは、これが作成操作であることを指定します。
成功したレスポンスは、割り当てられたIDを含む完全なチケットオブジェクトとともに、201 Createdステータスを返します。
タグでチケットを検索する
四半期レポートのために、escalation_oneとescalation_twoの両方のタグが付いたすべてのチケットを検索する必要があるとします。 UIビューにはアーカイブされたチケットが表示されないため、APIを使用します。
curl "https://your-subdomain.zendesk.com/api/v2/search.json" \
-G --data-urlencode "query=tags:escalation_one,escalation_two" \
-v -u jdoe@example.com/token:YOUR_API_TOKEN
-Gフラグは、データをURLパラメーターとして追加するようにcurlに指示し、--data-urlencodeはURLエンコードを自動的に処理します。 このクエリは、アーカイブされたものを含む、両方のタグが付いたすべてのチケットを返します。
ユーザーレコードの一括更新
複数のユーザーを一度に更新する必要がある場合は、一括更新エンドポイントを使用します。
curl https://your-subdomain.zendesk.com/api/v2/users/update_many.json \
-d '{"users": [{"id": 123, "tags": ["vip"]}, {"id": 456, "tags": ["vip"]}]}' \
-H "Content-Type: application/json" \
-v -u jdoe@example.com/token:YOUR_API_TOKEN -X PUT
これにより、1つのリクエストで両方のユーザーが更新されます。 制限を覚えておいてください。一度に最大100人のユーザーを更新でき、ユーザーあたり1分あたり5リクエストのレート制限があります。
Zendesk APIの価格と制限
良いニュース：すべてのZendeskプランにAPIアクセスが含まれています。 APIの使用に追加料金はかかりませんが、上位プランではレート制限が高くなります。
| プラン | 月額料金（年間） | APIレート制限 |
|---|---|---|
| Support Team | $19/エージェント | 200リクエスト/分 |
| Suite Team | $55/エージェント | 200リクエスト/分 |
| Suite Professional | $115/エージェント | 400リクエスト/分 |
| Suite Enterprise | $169/エージェント | 700リクエスト/分 |
1分あたり700を超えるリクエストが必要な場合は、High Volume APIアドオンを使用すると、制限が1分あたり2,500リクエストに増加します。 Suite Growth以上、およびSupport Professional以上で利用可能で、エージェントシートの最小数は10です。
注意すべきその他の制限：
- ページネーションは、ページあたり最大100件のレコードを返します。
- 検索は、クエリあたり最大1,000件の結果を返します。
- 一括操作は、リクエストあたり最大100件のレコードを処理します。
- 一度に最大30件のバックグラウンドジョブをキューに入れることができます。
ソース：Zendeskの価格
Zendesk APIを使用する場合と、ノーコードの代替手段を使用する場合
APIは強力ですが、常に適切なツールであるとは限りません。 判断方法を次に示します。
APIが理にかなっている場合
- 複雑な統合：Zendeskを独自のシステムまたはカスタムアプリケーションに接続する必要があります。
- 一括データ操作：数千件のレコードを移行するか、定期的なデータエクスポートが必要です。
- カスタムレポート：Zendeskの組み込みダッシュボードが提供しない分析が必要です。
- ワークフローの自動化：複数のシステムにわたる複雑なマルチステッププロセスをトリガーする必要があります。
ノーコードツールの方が優れている場合
- 簡単な自動化：ルーティングルール、自動応答、および基本的なチケット処理。
- 小規模チーム：API統合を構築および維持するための開発リソースがありません。
- クイックセットアップ：次のスプリントではなく、今日機能するものが必要です。
- AIを活用したサポート：コードを書かずにチケットを処理できるAIエージェントが必要です。
ここで私たちの出番です。 eesel AIは、Zendesk内でAIチームメイトとして機能します。 過去のチケットとヘルプセンターから学習し、最前線のサポートを自律的に処理します。 APIコーディングは必要ありません。 まず、eeselがレビュー用の返信を下書きすることから始め、それが証明されたら、完全な自動化にレベルアップします。
APIとAIエージェントは、相互に排他的ではありません。 多くのチームが両方を使用しています。データ統合とカスタムワークフローにはAPIを使用し、ルーチンな顧客との会話の処理にはAIエージェントを使用します。
今すぐZendeskワークフローの自動化を開始
Zendesk APIを使用すると、サポート操作をプログラムで制御できます。 データを一括インポートする場合でも、カスタム統合を構築する場合でも、自動化されたワークフローを作成する場合でも、APIには必要なエンドポイントがあります。
主なポイント：
- APIトークンは開始する最も速い方法です。 OAuthは、マルチカスタマーアプリに適しています。
- レート制限は、プランに応じて1分あたり200〜2,500リクエストです。
- 検索APIには、UIビューが見逃すアーカイブされたチケットが含まれています。
- 一括操作は、リクエストあたり最大100件のレコードを処理します。
開発作業なしで自動化を探している場合は、eesel AIをチームに招待してください。 当社のAIエージェントはZendeskと直接統合され、既存のチケットとドキュメントから数分でビジネスを学習し、最前線のサポートの最大81％を自律的に処理できます。 スコープを制御し、ライブになる前にパフォーマンスを確認し、eeselがそれを証明したらスケールアップします。
APIルートを選択するか、AIを活用したアプローチを選択するかにかかわらず、目標は同じです。手作業を減らし、応答を高速化し、顧客体験を向上させます。
