Hoppa till innehåll

pseudonymize.io API

Välkommen till pseudonymize.io-dokumentationen. Placera detta API i vägen för din känsliga data innan den når externa system (som LLM, analyslager eller tredjepartsstödverktyg).

Snabbstart

Skicka en begäran till Text API för att pseudonymisera 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

Alla API-förfrågningar måste inkludera din API-nyckel i "Authorization"-huvudet.

Authorization: Bearer ps_live_...

API-nycklar genereras i formatet "ps_live_...". För din säkerhet visas den fullständiga hemliga nyckeln endast en gång vid skapandet. pseudonymize.io lagrar aldrig API-nycklar i klartext – endast en icke-reversibel kryptografisk hash (SHA-256) och ett kort identifierande prefix (ps_live_XXXX) finns kvar.

Du kan hantera dina API-nycklar i Dashboard.

Text API

POST https://api.pseudonymize.io/text (även tillgängligt via POST https://api.pseudonymize.io/v1/text och /api/v1/text)

Ersätter identifierare inuti prosa utan att platta till texten runt dem.

Begäran

  • text (sträng, obligatorisk): Texten som ska bearbetas.
  • policy (sträng, valfritt): Policyn som ska användas. Standard är "standard".
  • detektera (array, valfritt): Specifika enhetstyper att upptäcka.
{
  "text": "Call me at +39 333 1234567.",
  "detect": ["PHONE"]
}

Structured Data API

POST /api/v1/data

Pseudonymisera identifierarfält samtidigt som rader och scheman är användbara.

Begäran

  • nyttolast (objekt | array, krävs): JSON-strukturen som ska bearbetas (kan även skickas som data).
  • policy (sträng, valfritt): Policyn som ska användas. Standard är "standard".
  • detektera (array, valfritt): Specifika enhetstyper att upptäcka.
{
  "payload": {
    "user": {
      "name": "Mario Rossi",
      "email": "[email protected]"
    }
  },
  "detect": ["PERSON", "EMAIL"]
}

Fakturering och kreditreservation

Pseudonymize.io arbetar på en transparent pay-as-you-go-modell:

  • 1 € per miljon uppmätta token. Varje lyckad begäran avrundas uppåt till block om 1 000 token (1 kredit), med en minimiavgift på 0,001 €.
  • Reservation före flygning: Krediter är atomiskt reserverade vid gatewaygränsen innan nyttolaster når kärnmotorn. Om ett konto har otillräckliga krediter, returnerar API:et "402 Payment Required" omedelbart utan att vidarebefordra kunddata.
  • Automatisk återbetalningsgaranti: Om ett uppströms centralbearbetningssamtal misslyckas eller timeout, återbetalas reserverade krediter omedelbart i sin helhet.

Pseudonymer och deterministisk identitet

Pseudonymize.io använder deterministisk identitetsbevarande inom en enda begäran. Om "Alice" förekommer tre gånger i samma dokument blir hon "PERSON_01" alla tre gångerna. Detta gör att LLM:er kan förstå att det är samma person utan att veta vem det är.

Fel och begränsningar

Vi använder vanliga HTTP-statuskoder.

  • 200 OK: Lyckad bearbetning.
  • 400 Bad Request: Ogiltigt eller saknat nyttolastformat, eller strukturerat datadjup som överstiger 32 nivåer.
  • 401 obehörig: Saknas, ogiltig eller inaktiv API-nyckel.
  • "402 Betalning krävs": Otillräckliga krediter kvar. Blockerad vid gatewaygränsen.
  • "413 nyttolast för stor": Begäran är större än 10 MB eller det totala antalet strukturerade element överstiger 50 000 nycklar.
  • 429 Too Many Requests: Hastighetsgränsen har överskridits (60 req/min per API-nyckel, 120 req/min per account and IP). Rubriken Retry-After anger när du ska försöka igen.
  • 502 Bad Gateway: Kärnmotorn går inte att nå eller backend-bearbetningsfel. Krediter återbetalas automatiskt.
  • 504 Gateway Timeout: Kärnmotorn svarade inte inom 30 sekunder. Krediter återbetalas automatiskt.

Entiteter som stöds

  • PERSON (namn)
  • ORGANISATION (företagsnamn)
  • EMAIL (e-postadresser)
  • PHONE (telefonnummer)
  • "PLATS" (städer, adresser)
  • "IP" (IPv4 och IPv6)
  • "IBAN" (bankkonton)
  • "KORT" (kredit-/betalkort)

Säkerhet

  • Gateway-faktureringstabeller och strukturerade förfrågningsmått utesluter API-begäran och svarsorgan. Metadata för konto, autentisering, användning, reservation och betalning bevaras separat; Radering av konto rensar inte varje post eller säkerhetskopia.
  • Framgångsrika svar med en Idempotency-Key bevaras i processminnet under ett återuppspelningsfönster på fem minuter. Enhetsuppgifter kan innehålla ursprungliga identifierare. Motor-, proxy-, swap-, crash-dump- och backupkontroller kräver separat verifiering; noll diskbeständighet garanteras inte över hela bearbetningskedjan.
  • Se integritetspolicyn och säkerhetssidan för hanterings- och raderingsgränser.