APIキーの取得と管理

PII Firewall の REST API・SDK をサーバーサイドから呼び出すには APIキー（pf_live_xxx）が必要です。

SDKはAPIキー不要

@pii-firewall/sdk はローカル処理のためAPIキー不要です。このページは REST API 経由でクラウド処理を行う場合の手順です。

---

APIキーの取得手順

APIキーの発行・管理は Developer Console（piifirewall.com/console）で行います。 メールアドレスによるワンタイムコード認証（OTP）でログインします。パスワードは不要です。

1. Developer Console にアクセス

piifirewall.com/console を開きます。

2. メール認証でログイン

① メールアドレスを入力し 「ワンタイムコードを送信」 をクリックします。 ② 届いたメールの 6桁コードを入力し 「認証する」 をクリックします。

パスワード不要

Developer Console はメールOTP（2段階認証）のみを使用します。毎回ログイン時にコードが送られます。

3. キーを発行する

ログイン後、左サイドバーの 🔑 APIキー管理 をクリックします。 「新しいキーを発行」欄にキー名（例: My Server Key）を入力し、発行 ボタンをクリックします。

pf_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

キーは一度しか表示されません

発行直後に必ずコピーしてください。画面を閉じると再表示できません。

4. 安全に保管する

# .env ファイルに保存（Git にコミットしないこと）
PII_FIREWALL_API_KEY=pf_live_xxxxxxxxxx

---

APIキーの使い方

curl

curl -X POST https://pii-firewallproxy-production.up.railway.app/detect \
  -H "Authorization: Bearer pf_live_xxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"text": "山田 太郎 090-1234-5678", "language": "ja", "extraTypes": ["name"]}'

Node.js（fetch）

const res = await fetch("https://pii-firewallproxy-production.up.railway.app/detect", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.PII_FIREWALL_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ text: "090-1234-5678", language: "ja" }),
});
const data = await res.json();
console.log(data.candidates); // 検出されたPII

---

プラン別 月間APIコール上限

プランごとの上限・機能詳細は プラン・機能一覧 をご覧ください。

上限に達した場合は HTTP 429 が返ります。

---

キーの管理

キーの管理はすべて piifirewall.com/console の 🔑 APIキー管理 から行います。

一覧・使用量の確認

ログイン後、🔑 APIキー管理 パネルで発行済みキーの一覧（キープレフィックス・名前・プラン・発行日）と今月のAPIコール数を確認できます。

キーの無効化

不要になったキーは一覧の 「無効化」 ボタンで即座に無効にできます。漏洩した場合も同様に操作してください。

---

利用可能なエンドポイント

エンドポイント	メソッド	説明
/detect	POST	PII検出（マスクなし）
/mask	POST	PIIマスク
/restore	POST	トークン復元
/detect-injection	POST	インジェクション検知

詳細は REST API リファレンス を参照してください。