pseudonymize.io API

Tervetuloa pseudonymize.io-dokumentaatioon. Aseta tämä sovellusliittymä arkaluonteisten tietojesi tielle ennen kuin se saavuttaa ulkoiset järjestelmät (kuten LLM:t, analytiikkavarastot tai kolmannen osapuolen tukityökalut).

Pika-aloitus

Lähetä pyyntö tekstin API:lle proosan pseudonyymisoimiseksi.

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

Vastaus:

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

Todennus

Kaikkien API-pyyntöjen on sisällettävä API-avaimesi "Authorization"-otsikossa.

Authorization: Bearer ps_live_...

API-avaimet luodaan muodossa ps_live_.... Turvallisuutesi vuoksi koko salainen avain näytetään vain kerran luonnin yhteydessä. pseudonymize.io ei koskaan tallenna API-avaimia selkeänä tekstinä – vain ei-palautettava kryptografinen hajautus (SHA-256) ja lyhyt tunnisteetuliite (ps_live_XXXX) säilyvät.

Voit hallita API-avaimia Dashboard -kohdassa.

Teksti API

POST https://api.pseudonymize.io/text (saatavilla myös kautta POST https://api.pseudonymize.io/v1/text ja /api/v1/text)

Korvaa proosan sisällä olevat tunnisteet tasoittamatta niiden ympärillä olevaa tekstiä.

Pyynnön elin

• "teksti" (merkkijono, pakollinen): Käsiteltävä teksti.
• "käytäntö" (merkkijono, valinnainen): käytettävä käytäntö. Oletusarvo on "oletus".
• detect (joukko, valinnainen): Tietyt tunnistettavat entiteettityypit.

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

Structured Data API

POST /api/v1/data

Pseudonymisoi tunnistekentät pitäen samalla rivit ja skeemat käyttökelpoisina.

Pyynnön elin

• hyötykuorma (objekti | array, pakollinen): Käsiteltävä JSON-rakenne (voidaan välittää myös datana).
• "käytäntö" (merkkijono, valinnainen): käytettävä käytäntö. Oletusarvo on "oletus".
• detect (joukko, valinnainen): Tietyt tunnistettavat entiteettityypit.

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

Laskutus- ja luottovaraus

Pseudonymize.io toimii läpinäkyvällä pay-as-you-go -mallilla:

• 1 € miljoonaa mitattua tokenia kohti. Jokainen onnistunut pyyntö pyöristetään ylöspäin 1 000 tokenin eriin (1 krediitti), ja vähimmäismaksu on 0,001 €.
• Pre-Flight Reservation: Krediitit on varattu atomaarisesti yhdyskäytävän rajalla ennen kuin hyötykuormat saavuttavat ydinmoottorin. Jos tilillä ei ole riittävästi saldoa, API palauttaa "402 Maksu vaaditaan" välittömästi välittämättä asiakastietoja.
• Automaattinen hyvitystakuu: Jos ylävirran ydinkäsittelypuhelu epäonnistuu tai aikakatkaisu, varatut hyvitykset palautetaan välittömästi kokonaisuudessaan.

Pseudonyymit ja deterministinen identiteetti

Pseudonymize.io käyttää determinististä identiteetin säilyttämistä yhdessä pyynnössä. Jos "Liisa" esiintyy kolme kertaa samassa asiakirjassa, hänestä tulee PERSON_01 kaikki kolme kertaa. Tämä antaa LLM:ille mahdollisuuden ymmärtää, että se on sama henkilö tietämättä kuka se on.

Virheet ja rajat

Käytämme tavallisia HTTP-tilakoodeja.

• 200 OK: Onnistunut käsittely.
• "400 virheellinen pyyntö": Virheellinen tai puuttuva hyötykuormamuoto tai strukturoidun tiedon syvyys ylittää 32 tasoa.
• 401 Luvaton: Puuttuva, virheellinen tai ei-aktiivinen API-avain.
• 402 Maksu vaaditaan: Ei tarpeeksi krediittejä jäljellä. Estetty yhdyskäytävän rajalla.
• "413 hyötykuorma liian suuri": Pyynnön runko ylittää 10 Mt tai strukturoitujen elementtien kokonaismäärä ylittää 50 000 avainta.
• "429 liian monta pyyntöä": Nopeusraja ylitetty (60 pyyntöä/min API-avainta kohti, 120 pyyntöä/min tiliä ja IP-osoitetta kohti). "Retry-After" -otsikko osoittaa, milloin yrittää uudelleen.
• 502 Bad Gateway: Ydinkoneeseen ei saada yhteyttä tai taustaprosessointivirhe. Luottotiedot palautetaan automaattisesti.
• 504 Gateway Timeout: Ydinmoottori ei vastannut 30 sekunnin kuluessa. Luottotiedot palautetaan automaattisesti.

Tuetut kokonaisuudet

• 'HENKILÖ' (nimet)
• "ORGANISAATIO" (yritysten nimet)
• EMAIL (sähköpostiosoitteet)
• PHONE (puhelinnumerot)
• "SIJAINTI" (kaupungit, osoitteet)
• "IP" (IPv4 ja IPv6)
• "IBAN" (pankkitilit)
• "CARD" (luotto-/pankkikortit)

Turvallisuus

• Yhdyskäytävän laskutustaulukot ja strukturoidut pyyntömittaukset eivät sisällä API-pyyntö- ja vastaustekstejä. Tili-, todennus-, käyttö-, varaus- ja maksumetatiedot säilytetään erikseen; tilin poistaminen ei tyhjennä jokaista tietuetta tai varmuuskopiota.
• Onnistuneet vastaukset Idempotency-Key:llä säilyvät prosessimuistissa viiden minuutin toistoikkunan ajan. Entiteetin tiedot voivat sisältää alkuperäisiä tunnisteita. Moottorin, välityspalvelimen, vaihto-, kaatumis- ja varaohjaukset vaativat erillisen vahvistuksen; nollalevyn pysyvyyttä ei taata koko käsittelyketjussa.
• Katso käsittely- ja poistorajoitukset Tietosuojakäytännöstä ja Turvallisuus-sivulta.