Spec

Frammenti di codice

curl "https://api.oanor.com/redact-api/v1/meta" \
  -H "x-oanor-key: oanor_test_..."

await fetch("https://api.oanor.com/redact-api/v1/meta", {
  headers: { "x-oanor-key": "oanor_test_..." }
});

$ch = curl_init("https://api.oanor.com/redact-api/v1/meta");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["x-oanor-key: oanor_test_..."]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$out = curl_exec($ch);

import requests
requests.get(
    "https://api.oanor.com/redact-api/v1/meta",
    headers={"x-oanor-key": "oanor_test_..."}
)

Risposta di esempio

Una risposta reale di questo endpoint, acquisita dall'ultimo health check.

{
    "data": {
        "name": "Redact API",
        "notes": "Types: email, phone, credit_card, ssn, ipv4, ipv6, iban (use 'ip' for both v4 and v6). Regex-based and best-effort — review before relying on it for compliance. Nothing is stored.",
        "version": "v1",
        "endpoints": [
            {
                "path": "/v1/redact",
                "params": {
                    "mask": "a label, a string, or a single char to repeat",
                    "text": "the text (required)",
                    "types": "comma list e.g. email,phone (default all)"
                },
                "returns": "the redacted text and per-type counts"
            },
            {
                "path": "/v1/detect",
                "params": {
                    "text": "the text (required)",
                    "types": "optional filter"
                },
                "returns": "the matches with their positions, without masking"
            },
            {
                "path": "/v1/meta",
                "params": [],
                "returns": "this document"
            }
        ],
        "description": "Detect and redact personally identifiable information (PII) in free text — email addresses, phone numbers, credit-card numbers (Luhn-validated), IPv4/IPv6 addresses, US Social Security numbers and IBANs. Mask them with a per-type label, a fixed string or a repeated character, or just detect them with positions. Pure local, no key — text never leaves the server."
    },
    "meta": {
        "timestamp": "2026-06-03T09:25:09.539Z",
        "request_id": "d261beca-42e3-44fb-adfc-e9037649be80"
    },
    "status": "ok",
    "message": "Meta",
    "success": true
}