Zendeskを使ってアプリ開発を行っている方、あるいはこれから使おうと考えている方むけに
よく使うAPIをまとめました。
少しでもZendeskで苦しんでいる人の助けになれば幸いです。
詳しいことは公式に記載されているため、困ったときは是非参照してみてください。
User関連
Zendeskにユーザーを作成したり、ユーザー情報を取得する場合に使用するAPIを記載します。
-
ユーザー情報取得
- ユーザのIDを使用してユーザー情報を取得します。
GET /api/v2/users/{id}.json
-
複数のユーザー情報取得
- ユーザのIDを使用して複数のユーザー情報を取得します。
- 例：
〜 ids=1,2,3
GET /api/v2/users/show_many.json?ids={ids}
-
ユーザー作成
- パラメーターを渡して、ユーザを作成します。
POST /api/v2/users.json
↓パラメーターの例
user: {
name: "test",
email: "test@test.com",
phone: "0001112222",
...
}
-
ユーザー更新
- パラメーターを渡して、ユーザ情報を更新します。
PUT /api/v2/users/{id}.json
↓パラメーターの例
user: {
id: 1111111,
email: "update@test.com",
...
}
チケット関連
Zendesk上でチケット周りを操作するAPIを記載します。
-
チケット作成
- パラメーターを渡して、チケットを作成します。
POST /api/v2/tickets.json
↓パラメーターの例
ticket: {
subject: "チケットのタイトル",
comment: {
body: "チケットの内容",
},
priority": "urgent",
...
}
-
チケット更新
- パラメーターを渡して、特定のチケット情報を更新します。
PUT /api/v2/tickets/{id}.json
↓パラメーターの例
ticket: {
id: 1234567,
subject: "タイトル変更",
comment: {
body: "チケットの内容変更",
},
...
}
記事関連
Zendeskでは記事を作成できるため、その記事を操作するAPIを記載します。
-
記事の取得
- 記事情報を取得します。
GET /api/v2/help_center/ja/articles.json
↑基本はこの形ですが、これだとすべての記事が取得されてしまいます。
それだと実用性に欠けるので、条件を絞っていきます。
-
カテゴリで取得
- Zendeskの記事を作成し、分類する上でカテゴリという概念が存在します。
- 該当するカテゴリの中にある記事のみを取得したい場合は以下になります。
GET /api/v2/help_center/ja/categories/{カテゴリのid}/articles.json
-
セクションで取得
- カテゴリの中に、さらに小さい単位でセクションと言うものが存在します。
- 該当するセクションの中にある記事のみを取得したい場合は以下になります。
GET /api/v2/help_center/ja/sections/{セクションのid}/articles.json
-
特定の記事をIDで取得
- 記事のIDを使用して、特定の記事のみを取得できます。
GET /api/v2/help_center/ja/ja/articles/${記事のid}.json`;
-
クエリで絞る
- 様々なクエリ条件を指定して、取得結果を操作することも可能です。
↓条件別にソートする
記事の更新日でソート
〜？sort_by=updated_at;
Zendesk画面上の表示順でソート
〜？sort_by=position;
上記でソートしたものを昇順or降順で並べる
〜？sort_by=updated_at＆sort_order=asc （降順ならdesc）
etc
↓ページングして取得する
?per_page=5&page=1；
per_pageで記事を何個単位でページングするか指定し
pageで何ページめを取得するか指定する。
例えば全部で８つの記事があった場合、per_pageが５なら
page=1で５つの記事、page=２で残りの3つの記事が取得される。
##参考
冒頭にも記載しましたが公式に詳しく記載されていますので困ったときは是非ご参照ください。