User Guide Ja – Individual API Key vs. Shared API Key

RedSyncは、RedmineのAPIにアクセスするために、RedmineのAPIキーを使用します。APIキーはユーザに対して一意であり、ユーザーのロールと権限に紐づいています。

RedSyncに登録されるAPIキーには次の２種類があります。

個別APIキー

プロジェクト管理者やプロジェクトメンバーの、それぞれのRedmineアカウントに割り当てられたAPIキーです。RedSyncがチケットの内容を更新すると、RedmineにはそれぞれのアカウントのIDで、変更が記録されます。

個別APIキーの登録は、設定画面またはメニューのアカウントリンクから行います。

共有APIキー

共有APIキーは、アカウントリンクに個別のAPIキーが登録されていないときに使われます。これはプロジェクトメンバーが、Redmineにアカウントを持たない場合などに利用できます。

共有キーを割り当てるには、Redmineにダミーのユーザーを作成し、プロジェクトに適切なロールで登録します。このユーザーのAPIキーを共有APIキーとして使用します。共有APIキーを使ったチケットの更新は、RedmineにそのダミーユーザーのIDで記録されます。このため監査性の観点からは、個別APIキーを使うほうが望ましいです。

共有APIキーの登録は、設定画面から行います。

何れの場合も、ユーザーがチケットにアクセスする適切な権限を持っていることが必要です。例えば、カードの読み取りだけであればReporter、更新も必要であればDeveloper相当の権限が必要です。

各APIキーを使用するRedSyncの機能と、APIキーを登録する場所を次に示します。Redmineと同期を行うには、必ず個別APIキーが必要です。