Redaction API Reference

const fetch = require('node-fetch');

const API_URL = 'https://api.redactionapi.net/v1/redact';
const API_KEY = 'your_api_key_here';

async function redactText(text, types) {
  const response = await fetch(API_URL, {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'X-API-Key': API_KEY
    },
    body: JSON.stringify({
      text: text,
      types: types,
      mask_char: '#'
    })
  });

  if (!response.ok) {
    throw new Error(`API error: ${response.status}`);
  }

  return response.json();
}

// Example usage
(async () => {
  const result = await redactText(
    'Contact [email protected] or call 555-123-4567',
    ['EMAIL_ADDRESS', 'PHONE_NUMBER']
  );

  console.log('Redacted:', result.redacted);
  console.log('Masked:', result.masked);
  console.log('Credits:', result.remaining_credits);
})();

curl -X POST https://api.redactionapi.net/v1/redact \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your_api_key_here" \
  -d '{
    "text": "Employee Sarah Johnson ([email protected])\nSSN: 123-45-6789\nPhone: +1 (555) 123-4567\nCredit Card: 4111 1111 1111 1111\nIP: 192.168.1.42",
    "types": [
      "PERSON_NAME",
      "EMAIL_ADDRESS",
      "SSN",
      "PHONE_NUMBER",
      "CREDIT_CARD_NUMBER",
      "IP_ADDRESS"
    ],
    "mask_char": "#"
  }'

<?php

$apiUrl = 'https://api.redactionapi.net/v1/redact';
$apiKey = 'your_api_key_here';

$payload = json_encode([
    'text'  => 'Contact [email protected], SSN: 123-45-6789',
    'types' => ['EMAIL_ADDRESS', 'SSN', 'PHONE_NUMBER'],
    'mask_char' => '#'
]);

$ch = curl_init($apiUrl);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST           => true,
    CURLOPT_POSTFIELDS     => $payload,
    CURLOPT_HTTPHEADER     => [
        'Content-Type: application/json',
        'X-API-Key: ' . $apiKey
    ]
]);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($httpCode === 200) {
    $result = json_decode($response, true);
    echo "Redacted: " . $result['redacted'] . "\n";
    echo "Masked: " . $result['masked'] . "\n";
    echo "Credits: " . $result['remaining_credits'] . "\n";
} else {
    echo "Error: HTTP " . $httpCode . "\n";
}

?>

import java.net.http.*;
import java.net.URI;

public class RedactionApiExample {

    private static final String API_URL = "https://api.redactionapi.net/v1/redact";
    private static final String API_KEY = "your_api_key_here";

    public static void main(String[] args) throws Exception {

        String jsonBody = """
            {
              "text": "Contact [email protected], SSN: 123-45-6789",
              "types": ["EMAIL_ADDRESS", "SSN", "PHONE_NUMBER"],
              "mask_char": "#"
            }
            """;

        HttpClient client = HttpClient.newHttpClient();

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create(API_URL))
            .header("Content-Type", "application/json")
            .header("X-API-Key", API_KEY)
            .POST(HttpRequest.BodyPublishers.ofString(jsonBody))
            .build();

        HttpResponse<String> response = client.send(
            request, HttpResponse.BodyHandlers.ofString()
        );

        System.out.println("Status: " + response.statusCode());
        System.out.println("Body: " + response.body());
    }
}