認証
APIキー
すべてのAPIリクエストはAPIキーで認証されます。
http
Authorization: Bearer YOUR_API_KEYAPIキーの取得
- piifirewall.com/app にサインイン
- 設定 → APIキー に移動
- 新しいキーを生成 をクリック
- キーをコピー — 表示されるのは一度だけです
キーのセキュリティ
- ソースコードにAPIキーをコミットしないでください
- 環境変数を使用してください:
PII_FIREWALL_API_KEY - 漏洩した場合は即座にローテーション(設定 → 無効化)
.env の例
bash
# .env
PII_FIREWALL_API_KEY=pfk_live_xxxxxxxxxxxxxxxxtypescript
import { PIIFirewall } from 'pii-firewall-sdk'
const firewall = new PIIFirewall({
apiKey: process.env.PII_FIREWALL_API_KEY!,
})キーのスコープ
| スコープ | 説明 |
|---|---|
read | 検出・クレジット確認 |
write | マスク・復元・全操作 |
admin | キー管理・使用ログの参照 |
デフォルトのキーは write スコープです。読み取り専用の統合にはスコープを制限してください。
キーのローテーション
ダウンタイムなしでキーをローテーションするには:
- ダッシュボードで新しいキーを生成
- 環境変数を更新
- サービスを再デプロイ
- 古いキーを無効化
IPアドレス制限(Enterprise)
EnterpriseプランではAPIキーの使用を特定のIPレンジに制限できます。enterprise@piifirewall.com にお問い合わせください。
