REST API
REST APIは、外部のアプリケーションがRedmine上の情報にアクセスできるようにするための仕組みです。チケットやWikiページなど様々なオブジェクトの作成・更新・読み取り・削除が行えます。
REST APIを利用したアプリケーションの開発
以下のRedmine公式サイトのリファレンスを参照してください。
Redmine API (redmine.org)
APIを有効にする方法
- システム管理者権限を持つユーザーでログインし、「管理」→「設定」画面の「API」タブ(Redmine 7.0以降の場合は「連携」タブ)を開く
- 「RESTによるWebサービスを有効にする」をONにする
- 「保存」ボタンをクリックして設定内容保存
ユーザー認証
REST APIを利用時のユーザー認証としては次の2つの方法が利用できます。
- OAuth2による認証（Redmine 6.1以降で利用可能）
- APIキーによる認証
セキュリティの観点から推奨される認証方法はOAuth2です。OAuth2はAPIを使用するアプリケーション単位でトークンを発行します。アプリケーションごとに必要最小限の権限を付与しやすく、またトークン単位での失効管理も可能です。一方で、OAuth2はAPIを利用するアプリケーションの開発において認証の実装と運用がやや複雑になるというデメリットがあります。また、利用できるのはRedmine 6.1以降に限られます。
APIキーによる認証は、セキュリティはOAuth2より劣るものの、アプリケーションの実装・運用が容易です。また、幅広いバージョンのRedmineで利用可能です。ただし、RedmineではAPIキーは1ユーザーにつき1個のAPIキーのみが利用できるため、複数のアプリケーションでAPIを利用する場合もすべて同一のAPIキーを共有することになります。そしてこのAPIキーを利用するアプリケーションはユーザーと同じ権限で動作するため、全アプリケーションに過剰な権限を与えた状態になる可能性があります。
OAuth2を用いたAPIアクセス手順
以下の記事で設定手順とアプリケーションのコード例を確認できます。
【Redmine 6.1以降対応】REST API OAuth2の使い方：設定手順とコード例
APIキーを用いたAPIアクセス手順
APIキーは以下の手順で取得できます。
- 画面右上の「個人設定」をクリックして個人設定画面を開く
- 右側のサイドバー内「APIアクセスキー」欄の「表示」をクリック
APIキーを使った認証方法についてはRedmine公式サイトのREST APIのリファレンス内の「Authentication」セクションを確認してください。
Redmine API - Authentication(redmine.org)
REST APIを使ったアプリケーション例
Redmineチケット★一括★
Excelシートを読み込んでチケットの作成・更新ができるWindows用フリーソフトウェア
詳細: Excelからチケットを作成・更新できる「Redmineチケット★一括★」 (Redmine.JP Blog)
関連情報
