Riferimento API

Documentazione API Privacy Shield

Tutto il necessario per integrare il rilevamento e la tokenizzazione dei dati personali nella tua applicazione.

Base URL: api.privacyshield.proAuth: X-API-Key headerFormat: JSON

Guida rapida

Ottieni la tua chiave API dalla dashboard ed esegui la prima richiesta in meno di due minuti.

# 1. Tokenize PII in a document
curl -X POST https://api.privacyshield.pro/api/v1/tokenize \
  -H "X-API-Key: ps_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Contatta Mario Rossi al 02-1234567 o mario.rossi@example.com"
  }'

# 2. Rehydrate tokens back to original PII
curl -X POST https://api.privacyshield.pro/api/v1/rehydrate \
  -H "X-API-Key: ps_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Contatta [PERSON_a1b2c3] al [PHONE_d4e5f6] o [EMAIL_g7h8i9]"
  }'

Autenticazione

Ogni richiesta deve includere la tua chiave API nell'header X-API-Key. Le chiavi sono precedute dal prefisso ps_live_ per la produzione e ps_test_ per la sandbox.

# Tutte le richieste devono includere questo header
X-API-Key: ps_live_YOUR_API_KEY

Endpoint

POST/api/v1/tokenizeCore
Analizza il testo alla ricerca di entità PII e le sostituisce con token reversibili. Supporta tipi di entità specifici per l'Italia: CF, IVA, IBAN e altro.

Corpo della richiesta

{
  "text": "string",          // required — document text (max 50 000 chars)
  "entity_types": ["string"] // optional — filter to specific types
}

Risposta

{
  "sanitized_text": "string",
  "entities": [
    {
      "type": "PERSON | CF | IVA | IBAN | EMAIL | PHONE | ADDRESS | DATE | ORG | OTHER",
      "original": "string",
      "token": "string",
      "start": 0,
      "end": 0
    }
  ],
  "token_count": 0,
  "latency_ms": 0
}
POST/api/v1/rehydrateCore
Detokenizzazione inversa: ripristina i token ai valori PII originali. Richiede la stessa chiave API usata durante la tokenizzazione.

Corpo della richiesta

{
  "text": "string" // required — text containing [TYPE_token] placeholders
}

Risposta

{
  "rehydrated_text": "string",
  "resolved_count": 0,
  "unresolved_tokens": ["string"]
}
POST/api/v1/flushPrivacy
Elimina definitivamente tutte le mappature di token per un dato scope. Usalo per soddisfare le richieste di cancellazione GDPR o per ruotare i namespace dei token.

Corpo della richiesta

{
  "scope": "all | session",  // required
  "session_id": "string"     // required when scope is "session"
}

Risposta

{
  "deleted_count": 0,
  "ok": true
}

Codici di errore

Stato HTTPCodiceSignificato
400invalid_requestJSON non valido o campo obbligatorio mancante.
401unauthorizedChiave API mancante o non valida.
422text_too_longIl testo supera i 50.000 caratteri consentiti.
429rate_limitedFrequenza di richieste superata per il tuo piano.
500internal_errorErrore interno del server. Riprova con backoff esponenziale.

Tipi di PII supportati

PERSON

Nomi e cognomi

e.g. Mario Rossi

CF

Codice Fiscale

e.g. RSSMRA85M10H501Z

IVA

Partita IVA

e.g. IT12345678901

IBAN

Conto bancario

e.g. IT60X0542811101000000123456

EMAIL

Indirizzi email

e.g. mario@example.com

PHONE

Numeri di telefono

e.g. +39 02 1234567

ADDRESS

Indirizzi stradali

e.g. Via Roma 1, Milano

DATE

Date di nascita

e.g. 15/03/1985

ORG

Ragioni sociali

e.g. Rossi S.r.l.

OTHER

PII residuale

e.g. —