REST API

更新日 2023/04/13

REST APIは、外部のアプリケーションがRedmine上の情報にアクセスできるようにするための仕組みです。チケットやWikiページなど様々なオブジェクトの作成・更新・読み取り・削除が行えます。

REST APIを利用したアプリケーションの開発

以下のリファレンスを参照してください。

Redmine API (redmine.org)

APIを有効にする方法

1. システム管理者権限を持つユーザーでログインし、「管理」→「設定」画面の「API」タブ(Redmine 3.1以前の場合は「認証」タブ)を開く
2. 「RESTによるWebサービスを有効にする」をONにする
3. 「保存」ボタンをクリックして設定内容保存

APIキーの取得

REST API利用時はAPIキーを使用した認証またはbasic認証を使用します。APIキーは以下の手順で取得できます。

1. 画面右上の「個人設定」をクリックして個人設定画面を開く
2. 右側のサイドバー内「APIアクセスキー」欄の「表示」をクリック

REST APIを使ったアプリケーション例

RedminePM

iPad / iPhone / AndroidからRedmineのチケットを操作できるクライアントアプリ

詳細: iPad / iPhone / Android対応のRedmineクライアントアプリ「RedminePM」 (Redmine.JP Blog)

Redmineチケット★一括★

Excelシートを読み込んでチケットの作成・更新ができるWindows用フリーソフトウェア

詳細: Excelからチケットを作成・更新できる「Redmineチケット★一括★」 (Redmine.JP Blog)

関連情報