İçeriğe atla

pseudonymize.io API'si

pseudonymize.io belgelerine hoş geldiniz. Bu API'yi, harici sistemlere (LLM'ler, analiz depoları veya üçüncü taraf destek araçları gibi) ulaşmadan önce hassas verilerinizin yoluna koyun.

Hızlı Başlangıç

Düzyazıya takma ad vermek için Metin API'sine bir istek gönderin.

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"
  }'

Cevap:

{
  "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" }
  ]
}

Kimlik Doğrulama

Tüm API isteklerinin "Yetkilendirme" başlığında API anahtarınızı içermesi gerekir.

Authorization: Bearer ps_live_...

API anahtarları ps_live_... biçiminde oluşturulur. Güvenliğiniz için, gizli anahtarın tamamı oluşturulduktan sonra yalnızca bir kez görüntülenir. pseudonymize.io, API anahtarlarını hiçbir zaman düz metin olarak saklamaz; yalnızca geri döndürülemez bir şifreleme karması ("SHA-256") ve kısa bir tanımlayıcı önek ("ps_live_XXXX") kalıcı olur.

API anahtarlarınızı [Kontrol Paneli](/kontrol paneli)'nden yönetebilirsiniz.

Metin API'si

POST https://api.pseudonymize.io/text (POST https://api.pseudonymize.io/v1/text ve /api/v1/text aracılığıyla da mevcuttur)

Düzyazı içindeki tanımlayıcıları, etraflarındaki metni düzleştirmeden değiştirir.

İstek Gövdesi

  • 'metin' (dize, gerekli): İşlenecek metin.
  • policy' (dize, isteğe bağlı): Kullanılacak politika. Varsayılan "varsayılan"`dır.
  • `algılama' (dizi, isteğe bağlı): Algılanacak belirli varlık türleri.
{
  "text": "Call me at +39 333 1234567.",
  "detect": ["PHONE"]
}

Yapılandırılmış Veri API'si

'POST /api/v1/data'

Satırları ve şemaları kullanılabilir durumda tutarken tanımlayıcı alanlarını takma adla kullanın.

İstek Gövdesi

  • 'payload' (nesne | dizi, gerekli): İşlenecek JSON yapısı ('veri' olarak da iletilebilir).
  • policy' (dize, isteğe bağlı): Kullanılacak politika. Varsayılan "varsayılan"`dır.
  • `algılama' (dizi, isteğe bağlı): Algılanacak belirli varlık türleri.
{
  "payload": {
    "user": {
      "name": "Mario Rossi",
      "email": "[email protected]"
    }
  },
  "detect": ["PERSON", "EMAIL"]
}

Faturalandırma ve Kredi Rezervasyonu

Pseudonymize.io şeffaf bir kullandıkça öde modeliyle çalışır:

  • Ölçülen bir milyon token başına €1. Her başarılı istek 1.000 tokenlık (1 kredi) bir sonraki bloğa yuvarlanır; minimum ücret €0,001’dir.
  • Uçuş Öncesi Rezervasyon: Krediler, yükler çekirdek motora ulaşmadan önce ağ geçidi sınırında atomik olarak ayrılır. Bir hesapta yeterli kredi yoksa API, müşteri verilerini iletmeden hemen "402 Ödeme Gerekli" ifadesini döndürür.
  • Otomatik Geri Ödeme Garantisi: Bir yukarı akış çekirdek işleme çağrısı başarısız olursa veya zaman aşımına uğrarsa, ayrılan kredilerin tamamı anında iade edilir.

Takma Adlar ve Deterministik Kimlik

Pseudonymize.io, tek bir istekte deterministik kimlik korumasını kullanır. "Alice" aynı belgede üç kez geçiyorsa üç kez de "PERSON_01" olur. Bu, Yüksek Lisans'ın kim olduğunu bilmeden aynı kişi olduğunu anlamasını sağlar.

Hatalar ve Sınırlar

Standart HTTP durum kodlarını kullanıyoruz.

  • 200 OK: Başarılı işlem.
  • '400 Hatalı İstek': Geçersiz veya eksik yük biçimi ya da 32 düzeyi aşan yapılandırılmış veri derinliği.
  • '401 Yetkisiz': Eksik, geçersiz veya etkin olmayan API anahtarı.
  • 402 Ödeme Gerekli: Yetersiz kredi kaldı. Ağ geçidi sınırında engellendi.
  • '413 Yükü Çok Büyük': İstek gövdesi 10 MB'ı aşıyor veya toplam yapılandırılmış öğe sayısı 50.000 anahtarı aşıyor.
  • 429 Çok Fazla İstek: Hız sınırı aşıldı (API anahtarı başına 60 istek/dakika, hesap ve IP başına 120 istek/dakika). 'Sonra Yeniden Dene' başlığı ne zaman yeniden deneneceğini gösterir.
  • '502 Hatalı Ağ Geçidi': Çekirdek motora ulaşılamıyor veya arka uç işleme hatası. Krediler otomatik olarak iade edilir.
  • '504 Ağ Geçidi Zaman Aşımı': Çekirdek motor 30 saniye içinde yanıt vermedi. Krediler otomatik olarak iade edilir.

Desteklenen Varlıklar

  • KİŞİ (İsimler)
  • ORGANİZASYON (Şirket isimleri)
  • EMAIL (E-posta adresleri)
  • TELEFON (Telefon numaraları)
  • LOKASYON (Şehirler, adresler)
  • 'IP' (IPv4 ve IPv6)
  • IBAN (Banka hesapları)
  • KART (Kredi/Banka kartları)

Güvenlik

  • Ağ geçidi faturalandırma tabloları ve yapılandırılmış istek metrikleri, API isteğini ve yanıt gövdelerini hariç tutar. Hesap, kimlik doğrulama, kullanım, rezervasyon ve ödeme meta verileri ayrı olarak saklanır; hesabın silinmesi her kaydı veya yedeği temizlemez.
  • Idempotency-Key ile başarılı yanıtlar, beş dakikalık bir tekrar penceresi boyunca işlem belleğinde tutulur. Varlık ayrıntıları orijinal tanımlayıcılar içerebilir. Motor, proxy, takas, kilitlenme dökümü ve yedekleme kontrolleri ayrı doğrulama gerektirir; İşlem zinciri boyunca sıfır disk kalıcılığı garanti edilmez.
  • İşleme ve silme sınırları için Gizlilik Politikası ve Güvenlik sayfasına bakın.