[テンプレ]外部インターフェース共通仕様

関連テンプレ構成
テンプレート
# 外部インターフェース共通仕様

## 認証・認可

**認証方式:**
- REST API: OAuth 2.0 / API Key
- メッセージング: 共有シークレット
- ファイル連携: SFTP認証(公開鍵/秘密鍵)

**認可:**
- ロールベースアクセス制御(RBAC- APIスコープによる権限管理

## エラーハンドリング

**共通エラーコード:**
- `AUTH_ERROR`: 認証エラー
- `PERMISSION_DENIED`: 権限エラー
- `INVALID_REQUEST`: リクエスト不正
- `SYSTEM_ERROR`: システムエラー
- `TIMEOUT`: タイムアウト

**リトライポリシー:**
- 一時的なエラー(5xx): 最大3回リトライ(指数バックオフ)
- クライアントエラー(4xx): リトライなし

## 監視・ログ

**記録項目:**
- リクエスト/レスポンス内容(個人情報はマスキング)
- 処理時間
- エラー詳細
- 送信元/送信先情報

---
プレビュー

外部インターフェース共通仕様

認証・認可

認証方式:

  • REST API: OAuth 2.0 / API Key
  • メッセージング: 共有シークレット
  • ファイル連携: SFTP認証(公開鍵/秘密鍵)

認可:

  • ロールベースアクセス制御(RBAC)
  • APIスコープによる権限管理

エラーハンドリング

共通エラーコード:

  • AUTH_ERROR: 認証エラー
  • PERMISSION_DENIED: 権限エラー
  • INVALID_REQUEST: リクエスト不正
  • SYSTEM_ERROR: システムエラー
  • TIMEOUT: タイムアウト

リトライポリシー:

  • 一時的なエラー(5xx): 最大3回リトライ(指数バックオフ)
  • クライアントエラー(4xx): リトライなし

監視・ログ

記録項目:

  • リクエスト/レスポンス内容(個人情報はマスキング)
  • 処理時間
  • エラー詳細
  • 送信元/送信先情報