API Reference

Authorization: Bearer YOUR_API_KEY

curl -X POST https://api.pii-fi.com/api/detect \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "text": "田中太郎（090-1234-5678）のメールはtanaka@example.comです。",
    "deidentification_type": "fake",
    "include_mapping_info": true
  }'

{
  "deidentified_text": "山田花子（080-9876-5432）のメールはyamada@example.comです。",
  "entities": [
    {
      "entity_type": "JPII_PERSON_NAME",
      "original_entity_type": "JP_COMPLEX_NAME",
      "original_text": "田中太郎",
      "masked_text": "山田花子",
      "start": 0,
      "end": 4,
      "confidence_score": 0.95
    },
    {
      "entity_type": "JPII_PHONE_NUMBER",
      "original_text": "090-1234-5678",
      "masked_text": "080-9876-5432",
      "start": 5,
      "end": 18,
      "confidence_score": 0.98
    },
    {
      "entity_type": "JPII_EMAIL_ADDRESS",
      "original_text": "tanaka@example.com",
      "masked_text": "yamada@example.com",
      "start": 24,
      "end": 42,
      "confidence_score": 0.99
    }
  ],
  "mapping_info": {
    "mappings": [
      {
        "original": "田中太郎",
        "fake": "山田花子",
        "entity_type": "JPII_PERSON_NAME"
      },
      {
        "original": "090-1234-5678",
        "fake": "080-9876-5432",
        "entity_type": "JPII_PHONE_NUMBER"
      },
      {
        "original": "tanaka@example.com",
        "fake": "yamada@example.com",
        "entity_type": "JPII_EMAIL_ADDRESS"
      }
    ]
  },
  "processing_info": {
    "processing_time_seconds": 0.15
  }
}

[
  {"text": "田中太郎です", "deidentification_type": "replace"},
  {"text": "電話: 090-1234-5678", "deidentification_type": "mask"}
]

[
  {
    "deidentified_text": "<人名>です",
    "entities": [...]
  },
  {
    "deidentified_text": "電話: 090-****-5678",
    "entities": [...]
  }
]

curl -X POST https://api.pii-fi.com/api/restore \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "text": "山田花子様、ご連絡ありがとうございます。",
    "mapping_info": {
      "mappings": [
        {"original": "田中太郎", "fake": "山田花子", "entity_type": "JPII_PERSON_NAME"}
      ]
    },
    "mode": "simple"
  }'

{
  "restored_text": "田中太郎様、ご連絡ありがとうございます。",
  "replace_count": 1,
  "processing_info": {
    "processing_time_seconds": 0.01
  },
  "stats": {
    "total_mappings": 1,
    "successful_replacements": 1
  }
}

{
  "policies": ["default", "strict", "minimal"],
  "active": "default",
  "count": 3
}

{
  "policy": {
    "version": "2.0",
    "entities": {
      "name": {"enabled": true},
      "phone": {"enabled": true},
      "email": {"enabled": false}
    }
  }
}

# ETag取得
ETAG=$(curl -s -I https://api.pii-fi.com/api/policy/active \
  -H "Authorization: Bearer YOUR_API_KEY" | grep -i etag | awk '{print $2}' | tr -d '\r')

# ポリシー作成
curl -X PUT https://api.pii-fi.com/api/policy/named/my_policy \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "If-Match: $ETAG" \
  -d '{
    "policy": {
      "version": "2.0",
      "entities": {
        "name": {"enabled": true},
        "email": {"enabled": false}
      }
    }
  }'

{
  "name": "employee_id_pattern",
  "regex": "EMP-\\d{6}",
  "score": 0.9
}

{
  "pipelines": [
    {
      "id": "pipeline.financial",
      "name": "金融情報分類パイプライン",
      "description": "金額の文脈を解析し、個人収入・企業収益・戦略情報を分類",
      "categories": [
        {"id": "PERSONAL_INCOME", "label": "個人収入"},
        {"id": "CORPORATE_EARNINGS", "label": "企業収益"},
        {"id": "CORPORATE_STRATEGIC", "label": "戦略情報"}
      ],
      "enabled": true
    }
  ],
  "count": 1
}

{
  "id": "PERSONAL_INCOME",
  "label": "個人収入",
  "context_keywords": ["年収", "月収", "給与", "給料", "手取り", "所得"],
  "entity_type": "JPII_PERSONAL_INCOME"
}

# ETag取得
ETAG=$(curl -s -I https://api.pii-fi.com/api/policy/active \
  -H "Authorization: Bearer YOUR_API_KEY" | grep -i etag | awk '{print $2}' | tr -d '\r')

# パイプライン作成
curl -X POST https://api.pii-fi.com/api/policy/pipelines \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "If-Match: $ETAG" \
  -d '{
    "id": "pipeline.financial",
    "name": "金融情報分類パイプライン",
    "description": "金額の文脈を解析し、機密カテゴリを自動分類",
    "categories": [
      {
        "id": "PERSONAL_INCOME",
        "label": "個人収入",
        "context_keywords": ["年収", "月収", "給与", "給料", "手取り"],
        "entity_type": "JPII_PERSONAL_INCOME"
      },
      {
        "id": "CORPORATE_EARNINGS",
        "label": "企業収益",
        "context_keywords": ["売上", "売上高", "収益", "利益", "営業利益"],
        "entity_type": "JPII_CORPORATE_EARNINGS"
      },
      {
        "id": "CORPORATE_STRATEGIC",
        "label": "戦略情報",
        "context_keywords": ["M&A", "買収", "合併", "出資", "投資額"],
        "entity_type": "JPII_CORPORATE_STRATEGIC"
      }
    ],
    "priority": 85
  }'

田中氏の年収は500万円です。A社の売上高は500万円でした。B社のM&A金額は500万円と報道されています。

{
  "deidentified_text": "<人名>の<個人収入>です。A社の<企業収益>でした。B社の<戦略情報>と報道されています。",
  "entities": [
    {
      "entity_type": "JPII_PERSON_NAME",
      "original_text": "田中氏",
      "masked_text": "<人名>",
      "confidence_score": 0.95
    },
    {
      "entity_type": "JPII_PERSONAL_INCOME",
      "original_text": "年収は500万円",
      "masked_text": "<個人収入>",
      "confidence_score": 0.92,
      "context_classification": {
        "pipeline_id": "pipeline.financial",
        "category": "PERSONAL_INCOME",
        "category_label": "個人収入",
        "context_keywords_matched": ["年収"]
      }
    },
    {
      "entity_type": "JPII_CORPORATE_EARNINGS",
      "original_text": "売上高は500万円",
      "masked_text": "<企業収益>",
      "confidence_score": 0.91,
      "context_classification": {
        "pipeline_id": "pipeline.financial",
        "category": "CORPORATE_EARNINGS",
        "category_label": "企業収益",
        "context_keywords_matched": ["売上高"]
      }
    },
    {
      "entity_type": "JPII_CORPORATE_STRATEGIC",
      "original_text": "M&A金額は500万円",
      "masked_text": "<戦略情報>",
      "confidence_score": 0.89,
      "context_classification": {
        "pipeline_id": "pipeline.financial",
        "category": "CORPORATE_STRATEGIC",
        "category_label": "戦略情報",
        "context_keywords_matched": ["M&A"]
      }
    }
  ]
}

{
  "detail": "Error message here"
}

{
  "detail": [
    {
      "type": "literal_error",
      "loc": ["body", "deidentification_type"],
      "msg": "Input should be 'replace', 'mask', 'full_mask', 'hash' or 'fake'",
      "input": "invalid_type"
    }
  ]
}