Pular para o conteúdo

API pseudonymize.io

Bem-vindo à documentação do pseudonymize.io. Coloque essa API no caminho dos seus dados confidenciais antes que eles cheguem a sistemas externos (como LLMs, data warehouses analíticos ou ferramentas de suporte de terceiros).

Início rápido

Envie uma solicitação à API Text para pseudonimizar a prosa.

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

Resposta:

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

Autenticação

Todas as solicitações de API devem incluir sua chave de API no cabeçalho Autorização.

Authorization: Bearer ps_live_...

As chaves de API são geradas no formato ps_live_.... Para sua segurança, a chave secreta completa é exibida apenas uma vez após a criação. pseudonymize.io nunca armazena chaves de API em texto simples – apenas um hash criptográfico não reversível (SHA-256) e um prefixo de identificação curto (ps_live_XXXX) são persistidos.

Você pode gerenciar suas chaves de API no Dashboard.

API de texto

POST https://api.pseudonymize.io/text (também disponível via POST https://api.pseudonymize.io/v1/text e /api/v1/text)

Substitui identificadores dentro da prosa sem achatar o texto ao seu redor.

Corpo da solicitação

  • text (string, obrigatório): O texto a ser processado.
  • policy (string, opcional): A política a ser usada. O padrão é "padrão".
  • detect (array, opcional): Tipos de entidades específicas a serem detectadas.
{
  "text": "Call me at +39 333 1234567.",
  "detect": ["PHONE"]
}

API de dados estruturados

POST /api/v1/dados

Pseudonimize campos de identificadores enquanto mantém linhas e esquemas utilizáveis.

Corpo da solicitação

  • payload (objeto | array, obrigatório): A estrutura JSON a ser processada (também pode ser passada como dados).
  • policy (string, opcional): A política a ser usada. O padrão é "padrão".
  • detect (array, opcional): Tipos de entidades específicas a serem detectadas.
{
  "payload": {
    "user": {
      "name": "Mario Rossi",
      "email": "[email protected]"
    }
  },
  "detect": ["PERSON", "EMAIL"]
}

Faturamento e reserva de crédito

Pseudonymize.io opera em um modelo transparente de pagamento conforme o uso:

  • €1 por milhão de tokens medidos. Cada pedido bem-sucedido é arredondado para cima em blocos de 1.000 tokens (1 crédito), com uma cobrança mínima de €0,001.
  • Reserva pré-voo: os créditos são reservados atomicamente no limite do gateway antes que as cargas cheguem ao mecanismo principal. Se uma conta tiver créditos insuficientes, a API retornará 402 Payment Required imediatamente, sem encaminhar os dados do cliente.
  • Garantia de reembolso automatizado: se uma chamada de processamento principal upstream falhar ou expirar, os créditos reservados serão reembolsados ​​integralmente imediatamente.

Pseudônimos e identidade determinística

Pseudonymize.io usa preservação determinística de identidade em uma única solicitação. Se "Alice" aparecer três vezes no mesmo documento, ela se tornará PERSON_01 nas três vezes. Isso permite que os LLMs entendam que se trata da mesma pessoa sem saber quem é.

Erros e Limites

Usamos códigos de status HTTP padrão.

  • 200 OK: Processamento bem-sucedido.
  • 400 Bad Request: Formato de carga útil inválido ou ausente ou profundidade de dados estruturados superior a 32 níveis.
  • 401 Unauthorized: Chave de API ausente, inválida ou inativa.
  • 402 Pagamento Necessário: Créditos restantes insuficientes. Bloqueado no limite do gateway.
  • 413 Payload Too Large: O corpo da solicitação excede 10 MB ou a contagem total de elementos estruturados excede 50.000 chaves.
  • 429 Too Many Requests: Limite de taxa excedido (60 req/min por chave API, 120 req/min por conta e IP). O cabeçalho Retry-After indica quando tentar novamente.
  • 502 Bad Gateway: mecanismo central inacessível ou falha no processamento de back-end. Os créditos são reembolsados ​​automaticamente.
  • 504 Gateway Timeout: O mecanismo principal não respondeu em 30 segundos. Os créditos são reembolsados ​​automaticamente.

Entidades Suportadas

  • PESSOA (Nomes)
  • ORGANIZAÇÃO (nomes de empresas)
  • EMAIL (endereços de e-mail)
  • TELEFONE (Números de telefone)
  • LOCATION (Cidades, endereços)
  • IP (IPv4 e IPv6)
  • IBAN (contas bancárias)
  • CARD (cartões de crédito/débito)

Segurança

  • As tabelas de cobrança do gateway e as métricas de solicitação estruturada excluem solicitações de API e corpos de resposta. Os metadados de conta, autenticação, uso, reserva e pagamento são retidos separadamente; a exclusão da conta não limpa todos os registros ou backups.
  • As respostas bem-sucedidas com um Idempotency-Key são retidas na memória do processo por uma janela de repetição de cinco minutos. Os detalhes da entidade podem conter identificadores originais. Os controles de mecanismo, proxy, swap, crash-dump e backup exigem verificação separada; a persistência zero em disco não é garantida em toda a cadeia de processamento.
  • Consulte a Política de Privacidade e a página Segurança para saber os limites de manuseio e exclusão.