common.skipToContent

API Справочник

Интегрируйте анонимизацию в ваши приложения

Полный REST API для программного обнаружения и анонимизации PII.


Базовый URL

https://anonymize.today/api

Все конечные точки API относительно этого базового URL. Например, конечная точка анализа — это https://anonymize.today/api/presidio/analyze.


Аутентификация

Аутентифицируйте API-запросы с помощью токенов Bearer:

Authorization: Bearer YOUR_API_TOKEN

Получение токена API

  1. Войдите в свою учетную запись anonymize.today
  2. Перейдите в Настройки → Учетная запись → Токены API
  3. Нажмите Создать новый токен
  4. Скопируйте и надежно сохраните свой токен (он больше не будет показан)

Примечание по безопасности

Никогда не раскрывайте свой токен API в клиентском коде или публичных репозиториях. Используйте переменные окружения и серверные запросы.

Токен в запросах

TypeScript

const response = await fetch('https://anonymize.today/api/presidio/analyze', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.ANONYMIZE_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ text, entities }),
});

Python

import os
import requests

headers = {
    "Authorization": f"Bearer {os.environ['ANONYMIZE_API_TOKEN']}",
    "Content-Type": "application/json"
}

response = requests.post(
    "https://anonymize.today/api/presidio/analyze",
    headers=headers,
    json={"text": text, "entities": entities}
)

cURL

curl -X POST https://anonymize.today/api/presidio/analyze \
  -H "Authorization: Bearer $ANONYMIZE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"text": "John Doe works at Acme Corp", "entities": ["PERSON", "ORGANIZATION"]}'

Лимиты запросов

Тип конечной точкиЛимит запросовРазрешение на всплеск: 10 запросов
Authentication3 requests/second5 requests
Analysis & Anonymization30 requests/second50 requests
Presets & Settings10 requests/second20 requests

При превышении лимита API возвращает 429 Слишком много запросов с заголовком Retry-After, указывающим, когда можно повторить попытку.


Основные конечные точки

Анализ текста

Обнаружение PII-сущностей в тексте. Возвращает позиции и типы обнаруженных сущностей.

Анонимизация текста

Анонимизация обнаруженных PII-сущностей с использованием различных операторов.

Деанонимизация текста

Восстановление зашифрованных сущностей до их исходных значений с использованием того же ключа шифрования.


Операторы анонимизации

ОператорОписаниеОбратимыйПример
replaceЗаменить на заполнительNoJohn → [PERSON]
maskЧастично замаскировать символыNojohn@email.com → j***@email.com
redactПолностью удалитьNoJohn → (empty)
hashОдносторонний хэш SHA-256NoJohn → a3f2b1c4...
encryptШифрование AES-256-GCMYesJohn → [ENC:...]

Конфигурации операторов

// Replace operator
{ "type": "replace", "new_value": "[PERSON]" }

// Mask operator
{
  "type": "mask",
  "masking_char": "*",
  "chars_to_mask": 5,
  "from_end": false
}

// Hash operator
{ "type": "hash", "hash_type": "sha256" }

// Encrypt operator (requires encryption key in user settings)
{ "type": "encrypt" }

// Redact operator
{ "type": "redact" }

API предустановок


Типы сущностей

anonymize.today поддерживает 256 типов сущностей в 10 категориях:

Personal

PERSON, EMAIL_ADDRESS, PHONE_NUMBER

Financial

CREDIT_CARD, IBAN_CODE, SWIFT_CODE, CRYPTO

Location

LOCATION, ADDRESS, COORDINATES

Government

SSN, PASSPORT, DRIVER_LICENSE, NATIONAL_ID

Contact

URL, DOMAIN_NAME

Technical

IP_ADDRESS, MAC_ADDRESS

Temporal

DATE_TIME, AGE

Organizational

ORGANIZATION, JOB_TITLE

Medical

MEDICAL_LICENSE, HEALTH_ID

Custom

User-defined patterns

Смотрите полный список типов сущностей в документации по предустановкам. Presets documentation.


Поддерживаемые языки

API поддерживает 27 языков для распознавания PII:

КодЯзыкДвижок
enEnglishspaCy
deGermanspaCy
esSpanishspaCy
frFrenchspaCy
itItalianspaCy
ptPortuguesespaCy
nlDutchspaCy
plPolishspaCy
ruRussianspaCy
jaJapanesespaCy
zhChinesespaCy
koKoreanspaCy
arArabicTransformer
hiHindiTransformer
trTurkishTransformer

Дополнительные языки: румынский, греческий, хорватский, словенский, македонский, шведский, датский, норвежский, финский, украинский, литовский, каталанский


Обработка ошибок

Стандартные коды состояния HTTP:

СтатусЗначениеОписание
200OKRequest succeeded
201CreatedResource created successfully
400Bad Request400 - Неверный запрос (недопустимые параметры)
401Unauthorized401 - Неавторизован (недопустимый или отсутствующий токен)
402Payment RequiredInsufficient tokens
403ForbiddenAccess denied to resource
404Not FoundResource not found
429Too Many Requests429 - Лимит запросов (слишком много запросов)
500Internal Error500 - Ошибка сервера (свяжитесь с поддержкой)

Формат ответа об ошибке

{
  "error": {
    "code": "INSUFFICIENT_TOKENS",
    "message": "You need 5 tokens but only have 2 remaining",
    "details": {
      "required": 5,
      "available": 2
    }
  }
}

Полные примеры

TypeScript/Node.js

import fetch from 'node-fetch';

const API_BASE = 'https://anonymize.today/api';
const API_TOKEN = process.env.ANONYMIZE_API_TOKEN;

async function analyzeAndAnonymize(text: string) {
  // Step 1: Analyze
  const analyzeResponse = await fetch(`${API_BASE}/presidio/analyze`, {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${API_TOKEN}`,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      text,
      entities: ['PERSON', 'EMAIL_ADDRESS', 'PHONE_NUMBER'],
      language: 'en',
    }),
  });

  const { results } = await analyzeResponse.json();

  if (results.length === 0) {
    return { text, anonymized: false };
  }

  // Step 2: Anonymize
  const anonymizeResponse = await fetch(`${API_BASE}/presidio/anonymize`, {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${API_TOKEN}`,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      text,
      analyzer_results: results,
      anonymizers: {
        DEFAULT: { type: 'replace', new_value: '[REDACTED]' },
      },
    }),
  });

  return anonymizeResponse.json();
}

// Usage
const result = await analyzeAndAnonymize('Contact John Doe at john@example.com');
console.log(result.text); // "Contact [REDACTED] at [REDACTED]"

Python

import os
import requests

API_BASE = "https://anonymize.today/api"
API_TOKEN = os.environ["ANONYMIZE_API_TOKEN"]

def analyze_and_anonymize(text: str) -> dict:
    headers = {
        "Authorization": f"Bearer {API_TOKEN}",
        "Content-Type": "application/json"
    }

    # Step 1: Analyze
    analyze_response = requests.post(
        f"{API_BASE}/presidio/analyze",
        headers=headers,
        json={
            "text": text,
            "entities": ["PERSON", "EMAIL_ADDRESS", "PHONE_NUMBER"],
            "language": "en"
        }
    )
    results = analyze_response.json()["results"]

    if not results:
        return {"text": text, "anonymized": False}

    # Step 2: Anonymize
    anonymize_response = requests.post(
        f"{API_BASE}/presidio/anonymize",
        headers=headers,
        json={
            "text": text,
            "analyzer_results": results,
            "anonymizers": {
                "DEFAULT": {"type": "replace", "new_value": "[REDACTED]"}
            }
        }
    )

    return anonymize_response.json()

# Usage
result = analyze_and_anonymize("Contact John Doe at john@example.com")
print(result["text"])  # "Contact [REDACTED] at [REDACTED]"

Related Documentation

Последнее обновление: Март 2026