📚 API DOCUMENTATION

Technical reference · v1

1. AUTHENTICATION

Every request to a /v1/* endpoint must include your license key as a Bearer token in the Authorization header. Requests without a valid, active key are rejected with a 401 response.

Authorization: Bearer BB-XXXX-XXXX

Your key is generated automatically and emailed to you after a successful Paddle checkout. Keep it secret — do not commit it to a public repository or expose it in client-side code.

2. ENDPOINTS BY CATEGORY

Privacy & PII Protection

• POST /v1/log_sanitizer — masks card numbers, emails and bearer tokens found in raw log text.
• POST /v1/pii_masker — partially masks card/email fields in a JSON payload.
• POST /v1/phone_sanitizer — normalizes phone numbers to E.164 format.
• POST /v1/ip_anonymizer — masks the last octet (IPv4) or block (IPv6) of an IP address.

Security & Link Integrity

• POST /v1/bot_detector — flags likely automated traffic from User-Agent/headers.
• POST /v1/link_signer — issues an HMAC-signed URL with an expiration timestamp.
• POST /v1/link_validator — verifies a signed URL's signature and expiration.

Data & Media Utilities

• POST /v1/csv_dedupe — deduplicates CSV rows by one or more key columns.
• POST /v1/exif_cloak — strips EXIF/comment metadata from a JPEG/PNG at the byte level.
• POST /v1/timezone_converter — converts a datetime between IANA timezones.
• POST /v1/uptime_check — makes a live HTTP request to a URL and returns status & latency.

3. EXAMPLE REQUEST

curl -X POST https://blackbox-apis.com/v1/log_sanitizer \
  -H "Authorization: Bearer BB-XXXX-XXXX" \
  -H "Content-Type: application/json" \
  -d '{"text":"card 4111111111111111 user@mail.com"}'

4. RESPONSE FORMAT

All endpoints return JSON. A successful response has the shape below; the exact fields depend on the endpoint called.

{
  "success": true,
  "result": "..."
}

Errors follow the same JSON envelope with success: false and a message describing the failure (invalid input, invalid/missing license key, etc.).

5. ACCESS SCOPE

A SOLO CORE license unlocks the endpoints of a single category you choose at checkout (3 or 4, depending on the category). A LABS ALL-ACCESS license unlocks all 11 endpoints across all 3 categories. Calling an endpoint outside your plan's scope returns a 401.

6. GOOD PRACTICES

• Store your license key in a server-side secret store, never in client-side code.
• Handle 401 responses explicitly instead of retrying blindly.
• Use HTTPS only — plain HTTP requests are rejected.