Μετάβαση στο περιεχόμενο

pseudonymize.io API

Καλώς ήρθατε στην τεκμηρίωση του pseudonymize.io. Τοποθετήστε αυτό το API στη διαδρομή των ευαίσθητων δεδομένων σας προτού φτάσουν σε εξωτερικά συστήματα (όπως LLM, αποθήκες αναλυτικών στοιχείων ή εργαλεία υποστήριξης τρίτων).

Γρήγορη εκκίνηση

Στείλτε ένα αίτημα στο Text API για ψευδώνυμα πεζογραφίας.

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

Απάντηση:

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

Έλεγχος ταυτότητας

Όλα τα αιτήματα API πρέπει να περιλαμβάνουν το κλειδί API στην κεφαλίδα «Εξουσιοδότηση».

Authorization: Bearer ps_live_...

Τα κλειδιά API δημιουργούνται με τη μορφή «ps_live_...». Για την ασφάλειά σας, το πλήρες μυστικό κλειδί εμφανίζεται μόνο μία φορά κατά τη δημιουργία. Το pseudonymize.io δεν αποθηκεύει ποτέ τα κλειδιά API σε απλό κείμενο—διατηρούνται μόνο ένας μη αναστρέψιμος κρυπτογραφικός κατακερματισμός (SHA-256) και ένα σύντομο πρόθεμα αναγνώρισης (ps_live_XXXX).

Μπορείτε να διαχειριστείτε τα κλειδιά API σας στο Dashboard.

API κειμένου

«POST https://api.pseudonymize.io/text» (διατίθεται επίσης μέσω των «POST https://api.pseudonymize.io/v1/text» και «/api/v1/text»)

Αντικαθιστά τα αναγνωριστικά μέσα στην πρόζα χωρίς να ισοπεδώνει το κείμενο γύρω τους.

Σώμα αιτήματος

  • «κείμενο» (συμβολοσειρά, απαιτείται): Το κείμενο προς επεξεργασία.
  • «πολιτική» (συμβολοσειρά, προαιρετική): Η πολιτική που θα χρησιμοποιηθεί. Προεπιλογές σε "προεπιλογή".
  • «ανίχνευση» (πίνακας, προαιρετικό): Συγκεκριμένοι τύποι οντοτήτων προς ανίχνευση.
{
  "text": "Call me at +39 333 1234567.",
  "detect": ["PHONE"]
}

API δομημένων δεδομένων

POST /api/v1/data

Προσδιορίστε ψευδώνυμα πεδία αναγνωριστικών, διατηρώντας παράλληλα τις σειρές και τα σχήματα που μπορούν να χρησιμοποιηθούν.

Σώμα αιτήματος

  • «ωφέλιμο φορτίο» (αντικείμενο | πίνακας, απαιτείται): Η δομή JSON προς επεξεργασία (μπορεί επίσης να μεταβιβαστεί ως «δεδομένα»).
  • «πολιτική» (συμβολοσειρά, προαιρετική): Η πολιτική που θα χρησιμοποιηθεί. Προεπιλογές σε "προεπιλογή".
  • «ανίχνευση» (πίνακας, προαιρετικό): Συγκεκριμένοι τύποι οντοτήτων προς ανίχνευση.
{
  "payload": {
    "user": {
      "name": "Mario Rossi",
      "email": "[email protected]"
    }
  },
  "detect": ["PERSON", "EMAIL"]
}

Κράτηση χρέωσης και πίστωσης

Το Pseudonymize.io λειτουργεί σε ένα διαφανές μοντέλο pay-as-you-go:

  • 1 € ανά εκατομμύριο μετρημένα tokens. Κάθε επιτυχές αίτημα στρογγυλοποιείται προς τα πάνω σε ομάδες 1.000 tokens (1 πίστωση), με ελάχιστη χρέωση 0,001 €.
  • Κράτηση πριν από την πτήση: Οι πιστώσεις δεσμεύονται ατομικά στο όριο της πύλης πριν τα ωφέλιμα φορτία φτάσουν στον βασικό κινητήρα. Εάν ένας λογαριασμός δεν έχει επαρκείς πιστώσεις, το API επιστρέφει αμέσως το "402 Payment Required" χωρίς να προωθήσει τα δεδομένα πελατών.
  • Εγγύηση αυτόματης επιστροφής χρημάτων: Εάν αποτύχει ή λήξει μια κλήση βασικής επεξεργασίας στο προηγούμενο ρεύμα, οι δεσμευμένες πιστώσεις επιστρέφονται αμέσως πλήρως.

Ψευδώνυμα & Ντετερμινιστική Ταυτότητα

Το Pseudonymize.io χρησιμοποιεί ντετερμινιστική διατήρηση ταυτότητας σε ένα μόνο αίτημα. Εάν το "Alice" εμφανίζεται τρεις φορές στο ίδιο έγγραφο, γίνεται "PERSON_01" και τις τρεις φορές. Αυτό επιτρέπει στους LLM να κατανοήσουν ότι είναι το ίδιο άτομο χωρίς να γνωρίζουν ποιος είναι.

Σφάλματα & Όρια

Χρησιμοποιούμε τυπικούς κωδικούς κατάστασης HTTP.

  • 200 OK: Επιτυχής επεξεργασία.
  • «400 Bad Request»: Μη έγκυρη ή λείπει μορφή ωφέλιμου φορτίου ή δομημένο βάθος δεδομένων που υπερβαίνει τα 32 επίπεδα.
  • «401 Μη εξουσιοδοτημένο»: Λείπει, δεν είναι έγκυρο ή ανενεργό κλειδί API.
  • "Απαιτείται πληρωμή 402": Απομένουν ανεπαρκείς πιστώσεις. Αποκλείστηκε στο όριο της πύλης.
  • 413 ωφέλιμο φορτίο πολύ μεγάλο: Το σώμα του αιτήματος υπερβαίνει τα 10 MB ή ο συνολικός αριθμός δομημένων στοιχείων υπερβαίνει τα 50.000 κλειδιά.
  • 429 Υπερβολικά Πολλά Αιτήματα: Υπέρβαση του ορίου ποσοστού (60 req/λεπτό ανά κλειδί API, 120 req/λεπτό ανά λογαριασμό και IP). Η κεφαλίδα "Επανάληψη-Μετά" υποδεικνύει πότε πρέπει να προσπαθήσετε ξανά.
  • 502 Bad Gateway: Ο βασικός κινητήρας δεν είναι προσβάσιμος ή αποτυχία επεξεργασίας backend. Οι πιστώσεις επιστρέφονται αυτόματα.
  • 504 Gateway Timeout: Ο βασικός κινητήρας δεν ανταποκρίθηκε εντός 30 δευτερολέπτων. Οι πιστώσεις επιστρέφονται αυτόματα.

Υποστηριζόμενες οντότητες

  • "PERSON" (Ονόματα)
  • «ΟΡΓΑΝΙΣΜΟΣ» (Επωνυμίες εταιρειών)
  • 'EMAIL' (Διευθύνσεις email)
  • «ΤΗΛΕΦΩΝΟ» (Αριθμοί τηλεφώνου)
  • «ΤΟΠΟΘΕΣΙΑ» (Πόλεις, διευθύνσεις)
  • IP (IPv4 και IPv6)
  • «IBAN» (Τραπεζικοί λογαριασμοί)
  • «ΚΑΡΤΑ» (Πιστωτικές/Χρεωστικές κάρτες)

Ασφάλεια

  • Οι πίνακες χρέωσης πύλης και οι μετρήσεις δομημένων αιτημάτων εξαιρούν τα σώματα αιτημάτων και απόκρισης API. Τα μεταδεδομένα λογαριασμού, ελέγχου ταυτότητας, χρήσης, κράτησης και πληρωμής διατηρούνται χωριστά. Η διαγραφή λογαριασμού δεν εκκαθαρίζει κάθε εγγραφή ή αντίγραφο ασφαλείας.
  • Οι επιτυχείς αποκρίσεις με ένα Idempotency-Key διατηρούνται στη μνήμη διεργασιών για ένα παράθυρο επανάληψης πέντε λεπτών. Τα στοιχεία της οντότητας ενδέχεται να περιέχουν πρωτότυπα αναγνωριστικά. Τα στοιχεία ελέγχου κινητήρα, διακομιστή μεσολάβησης, swap, crash-dump και backup απαιτούν ξεχωριστή επαλήθευση. Η μηδενική επιμονή του δίσκου δεν είναι εγγυημένη σε όλη την αλυσίδα επεξεργασίας.
  • Δείτε την Πολιτική Απορρήτου και τη σελίδα Ασφάλεια για τα όρια χειρισμού και διαγραφής.