BacklogのiPhoneアプリと合わせて開発されたBacklog API バージョン2を本日リリースいたしました。
これまでXML-RPC APIで提供していたAPIに加えて、新しい機能に対するAPIの追加や改善をおこないましたので、そのいくつかをここで紹介します。
詳しい利用方法やリクエストパラメータ・レスポンスデータついてはDeveloperサイトのBacklog APIのページをご確認ください。
※ XML-RPC APIも新しい機能の追加は行いませんが継続してご利用いただけます。
Wiki APIを追加しました
XML-RPC APIでは提供していなかった「Wiki」機能に関するAPIを追加いたしました。
APIからWikiデータの取得や、新しいWikiページの追加などを行うことができるようになりました。
- Wikiページ一覧の取得
- Wikiページタグ一覧の取得
- Wikiページの追加
- Wikiページ情報の取得
- Wikiページ情報の更新
- Wikiページの削除
- Wiki添付ファイルのダウンロード
- Wikiページ更新履歴一覧の取得
お知らせAPIを追加しました
同じくXML-RPC APIでは提供していなかった「お知らせ」機能に関するAPIを追加いたしました。
APIからお知らせ一覧の取得や、お知らせを既読にする操作ができるようになりました。
また、APIから取得した課題コメントのデータなどにもお知らせに関するデータが含まれるようになりました。
スターAPIを追加しました
同じくXML-RPC APIでは提供していなかった「スター」機能に関するAPIを追加いたしました。
スターの追加はもちろん、課題やコメント、Wikiページのデータにスターに関するデータが含まれるようになりました。
さらに、APIからユーザーが受け取ったスターの一覧も取得できるようになりました。
RESTベースのインターフェイスとJSON形式のレスポンス
Backlog API バージョン2ではインターフェイスにREST、レスポンスにJSON形式を採用しました。
認証方式
XML-RPC APIではユーザー名とパスワードをそのまま使用するBasic認証方式をサポートしていましたが、
Backlog API バージョン2ではAPI Key方式とOAuth2方式(後日提供予定)をサポートしました。API Keyの発行・削除はユーザーの個人設定のページから行うことが出来ます。
これによりAPIの利用する際にユーザーIDやパスワードを直接扱う必要がなくなったため、より安全にAPIを利用できるようになります。
公式のAPIライブラリ
Backlog API バージョン2をJavaから利用できる公式ライブラリとしてBacklog4j バージョン2の提供を予定しております。また、Backlog4jを使ったサンプルコードのページも追加する予定です。公開までしばらくお待ちください。
ここで紹介したように、新しく強力になったBacklog APIを利用して、開発者の方はBacklogをより便利に利用できるツールやアプリケーションを開発してみてください。また、Backlog APIを利用したアプリケーションを公開した際は是非Backlogのtwitterアカウントまでお知らせください。
また、これからも継続してAPIの改善を進めていきますので、改善案や要望がありましたらお気軽にこのブログのコメントや Uservoice 等でお知らせください。