Hopp til innhold

pseudonymize.io API

Velkommen til pseudonymize.io-dokumentasjonen. Plasser denne API-en i veien for de sensitive dataene dine før de når eksterne systemer (som LLM-er, analysevarehus eller tredjeparts støtteverktøy).

Hurtigstart

Send en forespørsel til Text API for å pseudonymisere prosa.

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

Svar:

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

Autentisering

Alle API-forespørsler må inkludere API-nøkkelen din i "Autorisasjon"-overskriften.

Authorization: Bearer ps_live_...

API-nøkler genereres i formatet 'ps_live_...'. For din sikkerhet vises den fullstendige hemmelige nøkkelen bare én gang ved opprettelse. pseudonymize.io lagrer aldri API-nøkler i ren tekst – bare en ikke-reversibel kryptografisk hash (SHA-256) og et kort identifiserende prefiks (ps_live_XXXX) er bevart.

Du kan administrere API-nøklene dine i Dashboard.

Tekst API

POST https://api.pseudonymize.io/text (også tilgjengelig via POST https://api.pseudonymize.io/v1/text og /api/v1/text)

Erstatter identifikatorer inne i prosa uten å flate ut teksten rundt dem.

Forespørselstekst

  • tekst (streng, obligatorisk): Teksten som skal behandles.
  • policy (streng, valgfritt): policyen som skal brukes. Standard til "standard".
  • "detect" (array, valgfritt): Spesifikke enhetstyper å oppdage.
{
  "text": "Call me at +39 333 1234567.",
  "detect": ["PHONE"]
}

Structured Data API

POST /api/v1/data

Pseudonymiser identifikatorfelt samtidig som rader og skjemaer er brukbare.

Forespørselstekst

  • nyttelast (objekt | array, påkrevd): JSON-strukturen som skal behandles (kan også sendes som data).
  • policy (streng, valgfritt): policyen som skal brukes. Standard til "standard".
  • "detect" (array, valgfritt): Spesifikke enhetstyper å oppdage.
{
  "payload": {
    "user": {
      "name": "Mario Rossi",
      "email": "[email protected]"
    }
  },
  "detect": ["PERSON", "EMAIL"]
}

Fakturering og kredittreservasjon

Pseudonymize.io opererer på en gjennomsiktig pay-as-you-go-modell:

  • €1 per million målte tokens. Hver vellykket forespørsel rundes opp til blokker på 1 000 tokens (1 kreditt), med en minimumsavgift på €0,001.
  • Reservasjon før flygning: Kreditter er atomreservert ved gateway-grensen før nyttelast når kjernemotoren. Hvis en konto har utilstrekkelig kreditt, returnerer API-en «402 Payment Required» umiddelbart uten å videresende kundedata.
  • Automatisk refusjonsgaranti: Hvis et oppstrøms kjernebehandlingsanrop mislykkes eller går ut, blir reserverte kreditter umiddelbart refundert i sin helhet.

Pseudonymer og deterministisk identitet

Pseudonymize.io bruker deterministisk identitetsbevaring i en enkelt forespørsel. Hvis «Alice» vises tre ganger i det samme dokumentet, blir hun «PERSON_01» alle tre gangene. Dette lar LLM-er forstå at det er den samme personen uten å vite hvem det er.

Feil og begrensninger

Vi bruker standard HTTP-statuskoder.

  • 200 OK: Vellykket behandling.
  • 400 Bad Request: Ugyldig eller manglende nyttelastformat, eller strukturert datadybde som overstiger 32 nivåer.
  • 401 Uautorisert: Manglende, ugyldig eller inaktiv API-nøkkel.
  • '402 Betaling kreves': Ikke nok kreditter igjen. Blokkert ved gateway-grensen.
  • 413 nyttelast for stor: Forespørselsteksten overskrider 10 MB eller totalt antall strukturerte elementer overstiger 50 000 nøkler.
  • 429 for mange forespørsler: Hastighetsgrensen er overskredet (60 krav/min per API-nøkkel, 120 krav/min per konto og IP). 'Retry-After'-overskriften indikerer når du skal prøve på nytt.
  • 502 Bad Gateway: Kjernemotor utilgjengelig eller backend-behandlingsfeil. Kreditter refunderes automatisk.
  • 504 Gateway Timeout: Kjernemotoren svarte ikke innen 30 sekunder. Kreditter refunderes automatisk.

Støttede enheter

  • PERSON (navn)
  • ORGANISASJON (selskapsnavn)
  • EMAIL (e-postadresser)
  • 'PHONE' (telefonnumre)
  • 'LOCATION' (byer, adresser)
  • IP (IPv4 og IPv6)
  • IBAN (bankkontoer)
  • KORT (kreditt-/debetkort)

Sikkerhet

  • Gateway-faktureringstabeller og strukturerte forespørselsverdier ekskluderer API-forespørsels- og svarinstanser. Konto-, autentiserings-, bruks-, reservasjons- og betalingsmetadata oppbevares separat; Sletting av konto sletter ikke alle poster eller sikkerhetskopier.
  • Vellykkede svar med en Idempotency-Key beholdes i prosessminnet i et vindu på fem minutter. Enhetsdetaljer kan inneholde originale identifikatorer. Motor-, proxy-, swap-, crash-dump og backup-kontroller krever separat verifisering; null diskutholdenhet er ikke garantert over hele behandlingskjeden.
  • Se personvernreglene og sikkerhetssiden for håndterings- og slettingsgrenser.