pseudonymize.io API

Name: pseudonymize.io
Price: 1.00 EUR
Author: pseudonymize.io

pseudonymize.io ドキュメントへようこそ。機密データが外部システム (LLM、分析ウェアハウス、サードパーティのサポートツールなど) に到達する前に、この API をそのパスに配置します。

クイックスタート

Text API にリクエストを送信して、散文を仮名化します。

curl -X POST https://api.pseudonymize.io/text \
  -H "Authorization: Bearer ps_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Alice Rossi disputed invoice INV-204 from [email protected]",
    "policy": "default"
  }'

応答：

{
  "text": "PERSON_01 disputed invoice INV-204 from EMAIL_01",
  "entities": [
    { "type": "PERSON", "original": "Alice Rossi", "pseudonym": "PERSON_01" },
    { "type": "EMAIL", "original": "[email protected]", "pseudonym": "EMAIL_01" }
  ]
}

認証

すべての API リクエストには、「Authorization」ヘッダーに API キーが含まれている必要があります。

Authorization: Bearer ps_live_...

API キーは「ps_live_...」の形式で生成されます。セキュリティのため、完全な秘密キーは作成時に 1 回だけ表示されます。 pseudonymize.io は API キーを平文で保存することはありません。非可逆暗号化ハッシュ (SHA-256) と短い識別プレフィックス (ps_live_XXXX) のみが保存されます。

API キーはダッシュボードで管理できます。

テキスト API

POST https://api.pseudonymize.io/text (POST https://api.pseudonymize.io/v1/text および /api/v1/text からも利用可能)

周囲のテキストを平坦化することなく、散文内の識別子を置き換えます。

リクエスト本文

text (文字列、必須): 処理するテキスト。
policy (文字列、オプション): 使用するポリシー。デフォルトは「デフォルト」です。
detect (配列、オプション): 検出する特定のエンティティタイプ。

{
  "text": "Call me at +39 333 1234567.",
  "detect": ["PHONE"]
}

構造化データ API

POST /api/v1/data

行とスキーマを使用可能な状態に保ちながら、識別子フィールドを仮名化します。

リクエスト本文

payload (オブジェクト | 配列、必須): 処理する JSON 構造 (data として渡すこともできます)。
policy (文字列、オプション): 使用するポリシー。デフォルトは「デフォルト」です。
detect (配列、オプション): 検出する特定のエンティティタイプ。

{
  "payload": {
    "user": {
      "name": "Mario Rossi",
      "email": "[email protected]"
    }
  },
  "detect": ["PERSON", "EMAIL"]
}

請求とクレジット予約

Pseudonymize.io は、透過的な従量課金制モデルで動作します。

計測トークン100万件あたり€1。成功したリクエストごとに1,000トークン（1クレジット）単位で切り上げ、最低料金は€0.001です。
プリフライト予約: ペイロードがコアエンジンに到達する前に、クレジットはゲートウェイ境界でアトミックに予約されます。アカウントのクレジットが不十分な場合、API は顧客データを転送せずに、すぐに「402 Payment Required」を返します。
自動返金保証: アップストリームのコア処理呼び出しが失敗またはタイムアウトした場合、予約されたクレジットは直ちに全額返金されます。

ペンネームと決定的なアイデンティティ

Pseudonymize.io は、単一のリクエスト内で 決定的な ID 保持を使用します。「Alice」が同じ文書内に 3 回出現する場合、彼女は 3 回とも「PERSON_01」になります。これにより、LLM は、それが誰であるかを知らなくても、それが同じ人物であることを理解できます。

エラーと制限

標準の HTTP ステータスコードを使用します。

200 OK: 処理が成功しました。
「400 Bad Request」: ペイロード形式が無効または欠落しているか、構造化データの深さが 32 レベルを超えています。
401 Unauthorized: API キーが見つからないか、無効であるか、非アクティブです。
402 Payment Required: クレジットが不足しています。ゲートウェイ境界でブロックされています。
413 Payload Too Large: リクエストボディが 10MB を超えているか、構造化要素の合計数が 50,000 キーを超えています。
「429 リクエストが多すぎます」: レート制限を超えました (API キーごとに 60 リクエスト/分、アカウントおよび IP ごとに 120 リクエスト/分)。 Retry-After ヘッダーは、いつ再試行するかを示します。
502 Bad Gateway: コアエンジンに到達できないか、バックエンド処理エラー。クレジットは自動的に返金されます。
「504 ゲートウェイタイムアウト」: コアエンジンが 30 秒以内に応答しませんでした。クレジットは自動的に返金されます。

サポートされるエンティティ

PERSON (名前)
ORGANIZATION (会社名)
EMAIL (メールアドレス)
PHONE (電話番号)
LOCATION (都市、住所)
IP (IPv4 および IPv6)
IBAN (銀行口座)
CARD (クレジット/デビットカード)

セキュリティ

ゲートウェイの請求テーブルと構造化リクエストメトリクスには、API リクエストとレスポンスの本文が含まれません。アカウント、認証、使用状況、予約、支払いのメタデータは個別に保持されます。アカウントを削除しても、すべてのレコードやバックアップが消去されるわけではありません。
Idempotency-Key による成功した応答は、5 分間の再生ウィンドウの間プロセスメモリに保持されます。エンティティの詳細には、元の識別子が含まれる場合があります。エンジン、プロキシ、スワップ、クラッシュダンプ、およびバックアップの制御には個別の検証が必要です。ゼロディスクの永続性は、処理チェーン全体で保証されません。
処理および削除の制限については、プライバシーポリシーとセキュリティのページを参照してください。