APIキーの取得と管理
Re:port Flow API の認証に使うアプリケーションキー（ak_ で始まる文字列）は、管理画面のワークスペース設定 → API連携から取得します。キーはワークスペース単位で発行され、appkey 方式を使う場合は各リクエストの appkey ヘッダーに設定します（OAuth 2.0 を使う場合は不要です）。このページでは、取得手順と安全な保管・ローテーションの方法を説明します。
APIキーはどこで取得する？
管理画面のワークスペース設定 → API連携に表示されています。ワークスペースを作成した時点でアプリケーションキーは自動生成されているため、別途申請する必要はありません。
1. ワークスペースを作成
Re:port Flowの管理画面（https://re-port-flow.com）にログインし、新しいワークスペースを作成します。
ワークスペース作成時に、アプリケーションキーが自動的に生成されます。
2. API連携情報を確認
ワークスペース詳細画面→「API連携」タブを開くと、以下の情報が表示されます：
- API URL:
https://api.re-port-flow.com/（コピーボタンあり） - アプリケーションキー:
ak_xxxxxxxxxxxxxxxx（コピーボタンあり）
各項目の右側にあるコピーボタンをクリックすると、値がクリップボードにコピーされます。
1ワークスペー スにつき1つのアプリケーションキー
各ワークスペースには1つのアプリケーションキーが紐付いています。キーは定期的に再生成して更新できます。
APIキーの管理
キーの確認
ワークスペース詳細画面の「API連携」タブで、現在のアプリケーションキー情報を確認できます：
- API URL:
https://api.re-port-flow.com/（コピー可能） - アプリケーションキー:
ak_xxxxxxxxxxxxxxxx（コピー可能） - 最終ローテーション日:
2024-02-14
セキュリティ推奨事項
環境変数での管理
推奨: APIキーは環境変数で管理し、コードにハードコードしない
# .env ファイル
REPORT_FLOW_APP_KEY=ak_xxxxxxxxxxxxxxxx
// 使用例
const appKey = process.env.REPORT_FLOW_APP_KEY;
.gitignoreへの追加
# APIキーを含むファイルをGit管理から除外
.env
.env.local
.env.production
secrets.json
定期的なローテーション
セキュリティ向上のため、3ヶ月ごとにアプリケーションキーを再生成することを推奨します。
ワークスペース詳細画面の「API連携」セクションで、最終ローテーション日から90日以上経過している場合、警告が表示されます。
UIからの再生成手順:
- ワークスペース詳細画面→「API連携」タブを開く
- 「アプリケーションキーを再生成」ボタンをクリック
- 確認モーダルで「再生成」を実行
- 表示された新しいキーをコピーし、アプリケーションに設定する
- 動作確認を実施
APIからの再生成方法:
curl -X POST \
https://api.re-port-flow.com/v1/workspace/{workspaceId}/application-token/regenerate \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json'
レスポンス例:
{
"applicationKey": "ak_xxxxxxxxxxxxxxxx",
"lastRotatedAt": "2024-02-14T10:30:00.000Z"
}
アプリケーションキーを再生成すると、古いキーは即座に無効になります。アプリケーションのダウンタイムを避けるため、新しいキーを速やかに設定に反映してください。
セキュリティ
Re:port FlowのAPIキーは、業界標準のセキュリティ対策により安全に管理されています：
- アプリケーションキーは暗号化されて保存されます
- すべてのAPI操作は監査ログに記録されます
- HTTPS通信のみをサポートし、平文での通信は受け付けません
セキュリティを最大限に高めるため、定期的なキーローテーション（3ヶ月ごと）を推奨します。
本番環境のセキュリティ要件
HTTPS通信必須・TLSバージョン要件については認証概要を参照してください。
その他のセキュリティベストプラクティス
APIキーの保管
- 環境変数で管理し、コードにハードコードしない
.gitignoreに.envファイルを追加- シークレット管理サービス（AWS Secrets Manager等）の使用を推奨
アクセス制御
- 必要最小限のワークスペースにのみAPIキーを発行
- 不要になったAPIキーは即座に再生成
- 定期的なアクセスログの監査
詳細な制限事項については、制限事項ページを参照してください。
トラブルシューティング
アプリケーションキーを再生成する場合
アプリケーションキーは管理画面の「API連携」タブから確認できます。確認できない場合は以下の手順で新しいキーを発行してください：
- ワークスペース詳細画面→「API連携」タブを開く
- 「アプリケーションキーを再生成」ボタンをクリック
- 確認モーダルで再生成を実行
- 表示された新しいキーをコピー
- アプリケーションの設定を新しいキーで更新
キーが動作しないときは？
多くはヘッダー名の大文字小文字か、キーのコピー漏れ・余分な空白が原因です。次のチェックリストを上から順に確認してください。
以下を確認してください：
-
appkeyヘッダーが正しく設定されているか - アプリケーションキーが正しくコピーされているか
- キーが有効化されているか（管理画面で確認）
- ヘッダー名が
appkey（小文字）になっているか