Redmine APIの活用法まとめ

公開日:  最終更新日:2016/04/15

まずは、RedmineのAPIでは必須のRESTについて、概略を押さえます。次に、Redmine REST APIにてチケット関連を中心に、使い方や設定方法を解説したサイトを紹介したいと思います。

API

Redmine REST APIの概略

APIとは何か

API (Application Programming Interface)とは、IT用語辞典によれば、「あるコンピュータプログラムの機能や管理するデータなどを、外部の他のプログラムから呼び出して利用するための手順やデータ形式などを定めた規約」を指しています。これにより、プログラム開発の軽減をはかっています。

RESTとは何か

REST (Representational State Transfer) の略で、「RESTはHTTP仕様に準拠したWebサービス」です。筆者が知る限りでは、下記のサイトで最もわかりやすく解説されています。
RESTのコンセプトと特徴 ~REST を知ると考え方が変わる~

Redmine REST APIの初期設定

使用を開始するには、メインメニューの「管理」から入り、有効化しなければなりません。その方法は、以下のサイトで図解入りの説明がありますので、参考になさってください。
RedmineのREST APIを使ってみる!

Redmine REST APIの種類

使用可能なデータの一覧は、r-labのページ (Redmine REST API) に紹介されています。チケットやプロジェクト、そしてユーザーの一覧表示をはじめとして、多くのデータが登録されています。

Redmine REST APIをトライアルで実行する

実施方法は以下のサイトの「【1】RESTはマッシュアップというWebサービスの一つ」の項目に、個々に説明されています。実行のためには、先の初期設定の方法で紹介したAPIキーが必要となります。
RedmineのREST APIは素晴らしい~ビッグデータの手法をRedmineにも活用する

Redmine REST APIの活用事例

チケット関連

(1) CSVファイルをインポートする
多数のチケットをまとめて作成できる、Windows用のプログラムです。MicrosoftのExcelと連動することにより、業務の効率化が可能です。
Excelからチケットを作成・更新できる「Redmineチケット★一括★」
(2) OutlookVBAを活用する
VBAマクロのサンプルが紹介されているので、同様の問題を抱えた方には貴重な情報です。
OutlookVBAでRedmineへRestAPI経由でチケット登録する例
(3) ワンライナー(1行だけのプログラム)のチケット処理
簡単で便利なので、方法を覚えると重宝します。
RedmineのREST APIを叩いてチケットのタイトルを見るワンライナー
redmine で一週間分の完了した担当チケットをリストアップするワンライナー
(4) チケット登録を簡略化
複数のチケット操作を自動化できます。
wget で Redmine のチケット登録
(5) チケットの登録
ここまでわかりやすいPythonからの事例紹介は珍しいのではないでしょうか。
PythonからREST API経由でRedmineにチケットを登録する(XML,JSON使用)
PythonからREST API経由でRedmineにコメントを登録する(XML,JSON使用)
PythonからREST API経由でRedmineに添付ファイルを登録する(XML,JSON使用)
(6) Git の利用時にRedmineと連携できるツール(Git-Redmine)
作業短縮と間違いを減らすことができます。ソースコードも公開されています。
Git-Redmine: GitのコミットとRedmineを連携する。チケット駆動開発にも。
(7) Redmine Java API libraryでの導入と設定例
大変に細かく解説されています。なお、Windowsにオールインワンのパッケージプログラム (Bitnami Redmine Stack)にて、環境を整えています。
RedmineのREST APIを使ってチケット登録・参照

ユーザー情報関連

(1) EXCEL VBAでユーザー情報の取得方法
サンプルコードが提供されているので、比較的円滑に検証が可能です。
Redmineのユーザー情報をEXCEL(VBA)で取得してみた

時間関連

(1) Redmineの作業時間を記録するツール
「チケット毎の工数管理や生産性の把握」に使用できます。Chrome ウェブストアからアプリを追加します。とても見やすい無料アプリです。
Redmine Time Tracker

Wiki関連

(1) Wikiの更新作業の改善
本サイトでは、「REST使って”xxx.rb –help”の内容をWikiにアップできるのでは?」からこちらの記事が書かれています。
RedmineのWikiをRESTで更新

Redmine REST APIの参考情報

(1) 総合マニュアル
サイトのタイトルの通り、大変わかりやすいマニュアルを提供するサービスです。新規作成・更新・削除といった基本操作について、カテゴリー毎に記載されています。
Easy Redmine REST API Documentation (英語)
(2) Redmine REST APIを使用するための総合情報
各種機能でデータを取得するためのURLリストをはじめとして、各連情報がわかりやすくまとめられています。
RedmineのREST APIは素晴らしい~ビッグデータの手法をRedmineにも活用する
(3) RedmineとChiliProject, JIRA, Microsoft Projectなどとデータ移行
どのような組み合わせでも移行が可能です。試用版と有償版(製品版)があります。
Task Adapter (英語)

まとめ文章

ここまでいかがでしたでしょうか。Redmineによるプロジェクト管理をより円滑に進めるために必要なAPIを紹介しました。Redmine REST APIの意義を、おわかりいただけましたでしょうか。
Redmine REST APIは大変に難しく上級者向けで、一般には導入が困難と思われがちです。ですが、今回紹介したサイトでは比較的わかりやすく解説されていて、Redmineを効率的に運用するヒントを与えてくれます。活用されてみてはいかがでしょうか。

管理人おすすめ「安心・安全」レンタルサーバーはコチラ!

価格・サーバースペックだけでなく、安定性やセキュリティ、サポート面から判断しました。個人運用だけでなく企業様におすすめのサーバーになります。

順位 イメージ サービス名/説明
1位 カゴヤジャパン カゴヤ・ジャパン
中小企業・小規模ECなど安定が必要なWebサイト運営に最適。専用サーバーが高品質で低価格です。
2位 NTTコミュニケーションズ NTTコミュニケーションズ(Bizメール&ウェブ)
大手NTTコミュニケーションズが提供するレンタルサーバーサービス。
3位 さくらインターネット さくらインターネット
個人におすすめのライト(月額129円)から、ビジネスプランまで幅広いラインナップ。

シェアありがとうございます

  • このエントリーをはてなブックマークに追加
  • Pocket
PAGE TOP ▲