Naar inhoud springen

pseudonimize.io API

Welkom bij de pseudonymize.io-documentatie. Plaats deze API in het pad van uw gevoelige gegevens voordat deze externe systemen bereiken (zoals LLM's, analysemagazijnen of ondersteuningstools van derden).

Snelstart

Stuur een verzoek naar de Text API om proza te pseudonimiseren.

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

Antwoord:

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

Authenticatie

Alle API-verzoeken moeten uw API-sleutel bevatten in de header Authorization.

Authorization: Bearer ps_live_...

API-sleutels worden gegenereerd in het formaat ps_live_.... Voor uw veiligheid wordt de volledige geheime sleutel slechts één keer weergegeven bij het aanmaken. pseudonymize.io slaat API-sleutels nooit op in leesbare tekst; alleen een niet-omkeerbare cryptografische hash (SHA-256) en een kort identificerend voorvoegsel (ps_live_XXXX) blijven behouden.

U kunt uw API-sleutels beheren in het Dashboard.

Tekst-API

POST https://api.pseudonymize.io/text (ook beschikbaar via POST https://api.pseudonymize.io/v1/text en /api/v1/text)

Vervangt identificatiegegevens binnen proza zonder de tekst eromheen af te vlakken.

Verzoektekst

  • text (string, vereist): de tekst die moet worden verwerkt.
  • beleid (tekenreeks, optioneel): het te gebruiken beleid. Standaard ingesteld op "standaard".
  • detect (array, optioneel): specifieke entiteitstypen om te detecteren.
{
  "text": "Call me at +39 333 1234567.",
  "detect": ["PHONE"]
}

Gestructureerde gegevens-API

POST/api/v1/data

Pseudonimiseer identificatievelden terwijl rijen en schema's bruikbaar blijven.

Verzoektekst

  • payload (object | array, vereist): de JSON-structuur die moet worden verwerkt (kan ook worden doorgegeven als data).
  • beleid (tekenreeks, optioneel): het te gebruiken beleid. Standaard ingesteld op "standaard".
  • detect (array, optioneel): specifieke entiteitstypen om te detecteren.
{
  "payload": {
    "user": {
      "name": "Mario Rossi",
      "email": "[email protected]"
    }
  },
  "detect": ["PERSON", "EMAIL"]
}

Facturering en kredietreservering

Pseudonymize.io werkt op een transparant pay-as-you-go-model:

  • €1 per miljoen gemeten tokens. Elk succesvol verzoek wordt naar boven afgerond op blokken van 1.000 tokens (1 credit), met een minimumtarief van €0,001.
  • Reservatie vóór de vlucht: Credits worden atomair gereserveerd op de gateway-grens voordat payloads de kernmotor bereiken. Als een account onvoldoende tegoed heeft, retourneert de API onmiddellijk '402 Payment Required' zonder klantgegevens door te sturen.
  • Geautomatiseerde restitutiegarantie: als een upstream kernverwerkingsgesprek mislukt of een time-out optreedt, worden gereserveerde tegoeden onmiddellijk volledig terugbetaald.

Pseudoniemen en deterministische identiteit

Pseudonymize.io maakt gebruik van deterministisch identiteitsbehoud binnen één verzoek. Als "Alice" drie keer in hetzelfde document voorkomt, wordt ze alle drie de keren 'PERSON_01'. Hierdoor kunnen LLM's begrijpen dat het dezelfde persoon is zonder te weten wie het is.

Fouten en limieten

Wij gebruiken standaard HTTP-statuscodes.

  • 200 OK: Succesvolle verwerking.
  • 400 Bad Request: ongeldig of ontbrekend payload-formaat, of gestructureerde gegevensdiepte groter dan 32 niveaus.
  • 401 Ongeautoriseerd: ontbrekende, ongeldige of inactieve API-sleutel.
  • 402 Betaling vereist: Er zijn onvoldoende resterende credits. Geblokkeerd bij de gatewaygrens.
  • 413 Payload Too Large: De hoofdtekst van het verzoek is groter dan 10 MB of het totale aantal gestructureerde elementen overschrijdt 50.000 sleutels.
  • 429 te veel verzoeken: snelheidslimiet overschreden (60 vereisten/min per API-sleutel, 120 vereisten/min per account en IP). De kop 'Retry-After' geeft aan wanneer u het opnieuw moet proberen.
  • 502 Bad Gateway: Kernengine onbereikbaar of verwerkingsfout in de backend. Tegoeden worden automatisch terugbetaald.
  • 504 Gateway Timeout: Core-engine reageerde niet binnen 30 seconden. Tegoeden worden automatisch terugbetaald.

Ondersteunde entiteiten

  • PERSOON (Namen)
  • ORGANISATIE (Bedrijfsnamen)
  • E-MAIL (E-mailadressen)
  • TELEFOON (Telefoonnummers)
  • LOCATIE (Steden, adressen)
  • IP (IPv4 en IPv6)
  • IBAN (Bankrekeningen)
  • CARD (Credit-/debetkaarten)

Beveiliging

  • Gateway-factureringstabellen en gestructureerde verzoekstatistieken sluiten API-verzoek- en responslichamen uit. Account-, authenticatie-, gebruiks-, reserverings- en betalingsmetagegevens worden afzonderlijk bewaard; Bij het verwijderen van een account wordt niet elke record of back-up gewist.
  • Succesvolle antwoorden met een Idempotency-Key worden gedurende een herhalingsvenster van vijf minuten in het procesgeheugen bewaard. Entiteitsgegevens kunnen originele identificatiegegevens bevatten. Engine-, proxy-, swap-, crash-dump- en back-upcontroles vereisen afzonderlijke verificatie; persistentie van nul schijven is niet gegarandeerd in de gehele verwerkingsketen.
  • Zie het Privacybeleid en de Beveiligingspagina voor verwerkings- en verwijderingslimieten.