API pseudonimize.io

Witamy w dokumentacji pseudonimize.io. Umieść ten interfejs API na ścieżce wrażliwych danych, zanim dotrą one do systemów zewnętrznych (takich jak LLM, hurtownie analityczne lub narzędzia wsparcia innych firm).

Szybki start

Wyślij żądanie do Text API w celu pseudonimizacji prozy.

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

Odpowiedź:

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

Uwierzytelnianie

Wszystkie żądania API muszą zawierać Twój klucz API w nagłówku Authorization.

Authorization: Bearer ps_live_...

Klucze API są generowane w formacie ps_live_.... Dla Twojego bezpieczeństwa cały tajny klucz jest wyświetlany tylko raz po utworzeniu. pseudonimize.io nigdy nie przechowuje kluczy API w postaci zwykłego tekstu — zachowywany jest jedynie nieodwracalny skrót kryptograficzny („SHA-256”) i krótki przedrostek identyfikacyjny („ps_live_XXXX”).

Możesz zarządzać swoimi kluczami API w Panelu.

Tekstowy interfejs API

POST https://api.pseudonymize.io/text (dostępny również poprzez POST https://api.pseudonymize.io/v1/text i /api/v1/text)

Zastępuje identyfikatory wewnątrz prozy bez spłaszczania tekstu wokół nich.

Treść żądania

• text (string, wymagany): Tekst do przetworzenia.
• policy (string, opcjonalny): Polityka, która ma być używana. Domyślnie jest to ``domyślne''.
• detect (tablica, opcjonalnie): Określone typy jednostek do wykrycia.

{
  "text": "Call me at +39 333 1234567.",
  "detect": ["PHONE"]
}

Interfejs API danych strukturalnych

POST /api/v1/data

Pseudonimizuj pola identyfikatorów, zachowując użyteczność wierszy i schematów.

Treść żądania

• ładunek (obiekt | tablica, wymagany): Struktura JSON do przetworzenia (może być również przekazana jako dane.
• policy (string, opcjonalny): Polityka, która ma być używana. Domyślnie jest to ``domyślne''.
• detect (tablica, opcjonalnie): Określone typy jednostek do wykrycia.

{
  "payload": {
    "user": {
      "name": "Mario Rossi",
      "email": "[email protected]"
    }
  },
  "detect": ["PERSON", "EMAIL"]
}

Rezerwacja rozliczeń i środków

Pseudonimize.io działa w oparciu o przejrzysty model płatności zgodnie z rzeczywistym użyciem:

• 1 € za milion mierzonych tokenów. Każde udane żądanie jest zaokrąglane w górę do bloków po 1000 tokenów (1 kredyt), z minimalną opłatą 0,001 €.
• Rezerwacja przed lotem: Kredyty są rezerwowane atomowo na granicy bramy, zanim ładunek dotrze do silnika podstawowego. Jeśli na koncie nie ma wystarczających środków, interfejs API natychmiast zwraca komunikat „402 Wymagana płatność” bez przesyłania danych klienta.
• Gwarancja automatycznego zwrotu kosztów: Jeśli wywołanie przetwarzania rdzenia upstream nie powiedzie się lub upłynie limit czasu, zarezerwowane kredyty zostaną natychmiast zwrócone w całości.

Pseudonimy i tożsamość deterministyczna

Pseudonymize.io wykorzystuje deterministyczne zachowanie tożsamości w ramach jednego żądania. Jeśli „Alicja” pojawia się trzy razy w tym samym dokumencie, za każdym razem staje się „PERSON_01”. Dzięki temu LLM mogą zrozumieć, że jest to ta sama osoba, nie wiedząc kto to jest.

Błędy i ograniczenia

Używamy standardowych kodów stanu HTTP.

• 200 OK: Pomyślne przetwarzanie.
• 400 Bad Request: Nieprawidłowy lub brakujący format ładunku albo głębokość danych strukturalnych przekraczająca 32 poziomy.
• 401 Nieautoryzowany: Brakujący, nieprawidłowy lub nieaktywny klucz API.
• 402 Wymagana płatność: Pozostała niewystarczająca ilość kredytów. Zablokowany na granicy bramy.
• 413 Payload Too Large: Treść żądania przekracza 10 MB lub całkowita liczba elementów strukturalnych przekracza 50 000 kluczy.
• 429 Too Many Requests: Przekroczono limit szybkości (60 żądań/min na klucz API, 120 żądań/min na konto i adres IP). Nagłówek „Retry-After” wskazuje, kiedy należy ponowić próbę.
• 502 Bad Gateway: Silnik podstawowy jest nieosiągalny lub błąd przetwarzania zaplecza. Kredyty są automatycznie zwracane.
• 504 Limit czasu bramy: Silnik podstawowy nie odpowiedział w ciągu 30 sekund. Kredyty są automatycznie zwracane.

Obsługiwane podmioty

• OSOBA (imiona)
• ORGANIZACJA (nazwy firm)
• EMAIL (adresy e-mail)
• TELEFON (numery telefonów)
• LOKALIZACJA (miasta, adresy)
• IP (IPv4 i IPv6)
• IBAN (konta bankowe)
• KARTA (karty kredytowe/debetowe)

Bezpieczeństwo

• Tabele rozliczeniowe bramy i metryki żądań strukturalnych nie uwzględniają treści żądań i odpowiedzi interfejsu API. Metadane dotyczące konta, uwierzytelnienia, użytkowania, rezerwacji i płatności są przechowywane osobno; usunięcie konta nie powoduje usunięcia każdego rekordu lub kopii zapasowej.
• Pomyślne odpowiedzi z Idempotency-Key są zachowywane w pamięci procesu przez pięciominutowe okno powtórki. Dane podmiotu mogą zawierać oryginalne identyfikatory. Kontrole silnika, proxy, wymiany, zrzutu awaryjnego i tworzenia kopii zapasowych wymagają osobnej weryfikacji; trwałość dysku zerowego nie jest gwarantowana w całym łańcuchu przetwarzania.
• Zobacz Politykę prywatności i stronę Bezpieczeństwo, aby zapoznać się z limitami obsługi i usuwania.