Backlog API

Backlog では、JSON をベースとしてよりご利用しやすい形式となった、Backlog API バージョン2を提供しております。
こちらのページで紹介しておりますバージョン1については、新しい機能の追加は行わない予定ですので、これから新規に API のご利用を考えている方は、ぜひバージョン2のご利用を検討ください。

なお、バージョン1についても、継続してご利用いただけます。( 現時点ではAPI提供停止の予定はございません )

Backlogでは、Backlogの提供するBacklog APIを利用して、新しいサービスやソフトウェアを作ろうとする、開発者の皆様のために情報提供をしています。

このBacklog APIを利用することにより、新たにアプリケーションを作成することが可能になります。それぞれの使用用途に合わせて作成する事ができ、今までご要望に応えられなかった機能の実現も可能になります。

多くの開発者に利用していただくよう、各種APIのドキュメントおよびサンプルコードについて、少しずつですが紹介していきたいと思います。

現在のBacklog APIはベータ版として公開しておりますので、ここで説明するAPIは仕様など随時変更される可能性があります。変更された内容は、お知らせにて告知いたします。

  • アイコン:プロトコルプロトコル

    Backlog APIは、XML-RPCで実装されています。
    XML-RPC の詳細は、http://www.xmlrpc.com/をご覧ください。

    すべてのメソッドで、リクエストに使用するURIはhttps://[スペースID].backlog.jp/XML-RPCです。
    ( 例: https://demo.backlog.jp/XML-RPC )

  • アイコン:認証・アクセス制限認証・アクセス制限

    APIを利用するには、通常のユーザアカウントと同じ認証情報が必要となります。認証には「Basic認証」を利用します。また、必ずHTTPS通信でアクセスする必要があります。

    課題の閲覧や追加の権限は通常のユーザ権限と同じです。「アクセス制限」の設定を行っている場合は、Backlog APIのアクセスも同様に制限されます。

アイコン:API変更履歴API変更履歴

R2013-06-20 での変更点 (2013/06/20)
既存のAPIに機能追加しました。
  • backlog.getProjects ... プロジェクト情報に親子課題の有効・無効とテキスト整形のルールが追加されました。
  • backlog.getProject ... プロジェクト情報に親子課題の有効・無効とテキスト整形のルールが追加されました。
  • backlog.getIssue ... 課題情報に親課題IDが追加されました。
  • backlog.countIssue ... 親課題のみ/子課題以外 の検索条件が追加されました。
  • backlog.findIssue ... 親課題のみ/子課題以外 の検索条件が追加されました。
  • backlog.createIssue ... 課題情報に親課題IDが追加されました。
  • backlog.updateIssue ... 課題情報に親課題IDが追加されました。
  • backlog.createIssue ... 登録パラメータで親課題の指定ができるようになりました
  • backlog.updateIssue ... 更新パラメータで親課題の追加・変更・解除ができるようになりました。
  • backlog.getTimeline ... 課題情報に親課題IDが追加されました。
APIを追加しました。
  • backlog.getChildIssues ... 親課題を指定してすべての子課題を取得します。
既存の管理者向けAPIに機能追加しました。
  • backlog.admin.getProjects ... プロジェクト情報に親子課題の有効・無効とテキスト整形のルールが追加されました。
  • backlog.admin.addProject ... プロジェクト情報に親子課題の有効・無効とテキスト整形のルールが追加されました。
  • backlog.admin.updateProject ... プロジェクト情報に親子課題の有効・無効とテキスト整形のルールが追加されました。
  • backlog.admin.deleteProject ... プロジェクト情報に親子課題の有効と無効、テキスト整形のルールが追加されました。
R2011-03-02 での変更点 (2011/03/02)
APIを追加しました。(マックスプランでのみ)
  • backlog.getCustomFields ... カスタム属性の一覧を取得します。
管理者向けAPIを追加しました。(マックスプランでのみ)
  • backlog.admin.addCustomField ... プロジェクトにカスタム属性を登録します。
  • backlog.admin.updateCustomField ... プロジェクトのカスタム属性を更新します。
  • backlog.admin.deleteCustomField ... プロジェクトからカスタム属性を削除します。
既存APIに機能追加しました。(マックスプランでのみ)
  • backlog.getIssue ... 課題取得時にカスタム属性のデータが含まれます。
  • backlog.findIssue ... 課題検索時にカスタム属性のデータが含められます。
  • backlog.createIssue ... 課題登録時にカスタム属性のデータを含められます。
  • backlog.updateIssue ... 課題更新時にカスタム属性のデータを含められます。
R2010-10-28 での変更点 (2010/10/28)
下記APIを追加しました。
  • backlog.getTimeline ... プロジェクトの最新更新情報を取得します。
  • backlog.getProjectSummary ... プロジェクト状況を取得します。
  • backlog.getProjectSummaries ... すべての参加プロジェクト状況を取得します。
  • backlog.getUser ... ユーザ情報を取得します。
  • backlog.getUserIcon ... ユーザアイコンを取得します。
  • backlog.getActivityTypes ... 最新更新情報の種別を取得します。
  • backlog.getStatuses ... 状態の一覧を取得します。
  • backlog.getResolutions ... 完了理由の一覧を取得します。
  • backlog.getPriorities ... 優先度の一覧を取得します。
  • backlog.addComment ... 課題にコメントを追加します。
R2010-03-31 での変更点 (2010/03/31)
  • 管理者向けAPIを追加しました (backlog.admin. からはじまる以下のメソッド)
    • backlog.admin.getUsers ... スペース内の全ユーザを取得します。
    • backlog.admin.addUser ... ユーザを追加します。
    • backlog.admin.updateUser ... ユーザ情報を更新します。
    • backlog.admin.deleteUser ... ユーザを削除します。
    • backlog.admin.getProjects ... スペースの全プロジェクトを取得します。
    • backlog.admin.addProject ... プロジェクトを追加します。
    • backlog.admin.updateProject ... プロジェクトを更新します。
    • backlog.admin.deleteProject ... プロジェクトを削除します。
    • backlog.admin.getProjectUsers ... プロジェクト参加ユーザリストを取得します。
    • backlog.admin.addProjectUser ... プロジェクト参加ユーザリストを1人追加します。
    • backlog.admin.updateProjectUsers ... プロジェクト参加ユーザリストを一括更新します。
    • backlog.admin.deleteProjectUser ... プロジェクト参加ユーザリストを1人不参加にします。

  • プロジェクト設定に関する以下のAPIを追加しました。
    • backlog.addIssueType ... プロジェクトの課題種別を追加します。
    • backlog.updateIssueType ... プロジェクトの課題種別を更新します。
    • backlog.deleteIssueType ... プロジェクトの課題種別を削除します。
    • backlog.addVersion ... プロジェクトの発生バージョン/マイルストーンを追加します。
    • backlog.updateVersion ... プロジェクトの発生バージョン/マイルストーンを更新します。
    • backlog.deleteVersion ... プロジェクトの発生バージョン/マイルストーンを削除します。
    • backlog.addComponent ... プロジェクトのカテゴリを追加します。
    • backlog.updateComponent ... プロジェクトのカテゴリを更新します。
    • backlog.deleteComponent ... プロジェクトのカテゴリを削除します。
R2009-01-30 での変更点 (2009/01/30)
  • 課題の検索・件数取得時に、課題の登録日・更新日・開始日・期限日をそれぞれ範囲で指定することができるようになりました。
R2008-11-28 での変更点 (2008/11/28)
  • 課題の属性に開始日・予定時間・実績時間が追加されました。(プレミアムプラン以上)
  • 課題の追加時に開始日・予定時間・実績時間を設定できるようになりました。(プレミアムプラン以上で設定可能)
R2008-09-30 での変更点 (2008/09/30)
  • 課題の追加時に担当者を設定できるようになりました。
  • カテゴリ・発生バージョン・マイルストーン・担当者・期限日・完了理由が「未設定」にできるようになりました。
Back to top