Passer au contenu

API pseudonymize.io

Bienvenue dans la documentation de pseudonymize.io. Placez cette API sur le chemin de vos données sensibles avant qu'elles n'atteignent des systèmes externes (comme les LLM, les entrepôts d'analyse ou les outils de support tiers).

Démarrage rapide

Envoyez une requête à l'API Text pour pseudonymiser la prose.

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

Réponse:

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

Authentification

Toutes les requêtes API doivent inclure votre clé API dans l'en-tête « Autorisation ».

Authorization: Bearer ps_live_...

Les clés API sont générées au format ps_live_.... Pour votre sécurité, la clé secrète complète s'affiche une seule fois lors de sa création. pseudonymize.io ne stocke jamais les clés API en texte brut : seuls un hachage cryptographique non réversible (SHA-256) et un court préfixe d'identification (ps_live_XXXX) sont conservés.

Vous pouvez gérer vos clés API dans le Dashboard.

API de texte

POST https://api.pseudonymize.io/text (également disponible via POST https://api.pseudonymize.io/v1/text et /api/v1/text)

Remplace les identifiants dans la prose sans aplatir le texte qui les entoure.

Corps de la demande

  • text (chaîne, obligatoire) : Le texte à traiter.
  • policy (chaîne, facultatif) : La politique à utiliser. La valeur par défaut est « par défaut ».
  • detect (tableau, facultatif) : types d'entités spécifiques à détecter.
{
  "text": "Call me at +39 333 1234567.",
  "detect": ["PHONE"]
}

API de données structurées

POST /api/v1/données

Pseudonymisez les champs d’identifiant tout en gardant les lignes et les schémas utilisables.

Corps de la demande

  • payload (objet | tableau, obligatoire) : La structure JSON à traiter (peut également être transmise en tant que data).
  • policy (chaîne, facultatif) : La politique à utiliser. La valeur par défaut est « par défaut ».
  • detect (tableau, facultatif) : types d'entités spécifiques à détecter.
{
  "payload": {
    "user": {
      "name": "Mario Rossi",
      "email": "[email protected]"
    }
  },
  "detect": ["PERSON", "EMAIL"]
}

Facturation et réservation de crédit

Pseudonymize.io fonctionne sur un modèle transparent de paiement à l'utilisation :

  • 1 € par million de tokens mesurés. Chaque requête réussie est arrondie au bloc supérieur de 1 000 tokens (1 crédit), avec un minimum de 0,001 €.
  • Réservation avant vol : les crédits sont réservés de manière atomique à la limite de la passerelle avant que les charges utiles n'atteignent le moteur principal. Si un compte ne dispose pas de crédits suffisants, l'API renvoie immédiatement « 402 Paiement requis » sans transmettre les données du client.
  • Garantie de remboursement automatisé : si un appel de traitement de base en amont échoue ou expire, les crédits réservés sont immédiatement remboursés intégralement.

Pseudonymes et identité déterministe

Pseudonymize.io utilise la préservation déterministe de l'identité au sein d'une seule requête. Si « Alice » apparaît trois fois dans le même document, elle devient « PERSON_01 » toutes les trois fois. Cela permet aux LLM de comprendre qu'il s'agit de la même personne sans savoir de qui il s'agit.

Erreurs et limites

Nous utilisons des codes de statut HTTP standard.

  • 200 OK : traitement réussi.
  • « 400 Bad Request » : format de charge utile invalide ou manquant, ou profondeur de données structurées dépassant 32 niveaux.
  • « 401 non autorisé » : clé API manquante, invalide ou inactive.
  • « 402 Paiement requis » : crédits restants insuffisants. Bloqué à la limite de la passerelle.
  • « 413 Payload Too Large » : le corps de la requête dépasse 10 Mo ou le nombre total d'éléments structurés dépasse 50 000 clés.
  • « 429 trop de requêtes » : limite de débit dépassée (60 req/min par clé API, 120 req/min par compte et IP). L'en-tête « Retry-After » indique quand réessayer.
  • « 502 Bad Gateway » : moteur principal inaccessible ou échec du traitement backend. Les crédits sont automatiquement remboursés.
  • « 504 Gateway Timeout » : le moteur principal n'a pas répondu dans les 30 secondes. Les crédits sont automatiquement remboursés.

Entités prises en charge

  • PERSON (Noms)
  • ORGANISATION (Noms de sociétés)
  • EMAIL (adresses e-mail)
  • PHONE (numéros de téléphone)
  • LOCATION (Villes, adresses)
  • IP (IPv4 et IPv6)
  • IBAN (Comptes bancaires)
  • CARD (cartes de crédit/débit)

Sécurité

  • Les tableaux de facturation de la passerelle et les métriques de requêtes structurées excluent les corps de requête et de réponse d'API. Les métadonnées du compte, de l'authentification, de l'utilisation, de la réservation et du paiement sont conservées séparément ; la suppression du compte ne purge pas tous les enregistrements ou sauvegardes.
  • Les réponses réussies avec un Idempotency-Key sont conservées dans la mémoire du processus pendant une fenêtre de relecture de cinq minutes. Les détails de l'entité peuvent contenir des identifiants originaux. Les contrôles du moteur, du proxy, du swap, du vidage sur incident et de la sauvegarde nécessitent une vérification distincte ; la persistance zéro du disque n’est pas garantie tout au long de la chaîne de traitement.
  • Consultez la politique de confidentialité et la page Sécurité pour connaître les limites de traitement et de suppression.