Protocol / Enforcement API

Enforcement API

Integrate Zytheron's enforcement capabilities directly into your platform with our RESTful API. Automate detection, monitoring, and takedown workflows programmatically.

API Overview

The Zytheron Enforcement API provides programmatic access to our full suite of enforcement tools. Built on REST principles with JSON request/response format, the API enables developers to integrate content protection directly into their workflows, platforms, and applications.

BASE URL: https://api.zytheron.com/v2

ENDPOINTS:
  POST   /scan              — Submit content for scanning
  GET    /scan/:id          — Get scan results
  POST   /enforce           — Initiate enforcement action
  GET    /enforce/:id       — Get enforcement status
  GET    /reports           — List enforcement reports
  POST   /fingerprint       — Register content fingerprint
  GET    /monitor/:assetId  — Get monitoring status
  DELETE /enforce/:id       — Cancel enforcement action

Authentication

All API requests require authentication via API keys. Keys are issued per organization and can be scoped to specific permissions (read-only, enforcement, admin). API keys should be included in the Authorization header of every request.

Authorization: Bearer zy_live_xxxxxxxxxxxxxxxxxxxx

# Rate Limits:
# Standard:    100 requests/minute
# Professional: 500 requests/minute
# Enterprise:  5,000 requests/minute

Quick Start Example

Submit a content scan and initiate enforcement in just two API calls:

# 1. Submit content for scanning
curl -X POST https://api.zytheron.com/v2/scan \
  -H "Authorization: Bearer zy_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "content_url": "https://example.com/protected-content",
    "asset_id": "asset_abc123",
    "scan_depth": "comprehensive"
  }'

# Response:
{
  "scan_id": "scan_7x92k",
  "status": "processing",
  "estimated_time": "< 3s"
}

# 2. Initiate enforcement on detected infringement
curl -X POST https://api.zytheron.com/v2/enforce \
  -H "Authorization: Bearer zy_live_xxx" \
  -d '{
    "scan_id": "scan_7x92k",
    "action": "takedown",
    "protocol": "dmca"
  }'

Webhooks & Events

Configure webhooks to receive real-time notifications for enforcement events. Supported events include scan.completed, enforcement.initiated, enforcement.completed, enforcement.failed, counter_notice.received, and monitor.alert.

POST /webhooks
{
  "url": "https://your-app.com/webhook",
  "events": ["enforcement.completed", "monitor.alert"],
  "secret": "whsec_xxxxxxxxxx"
}

SDKs & Libraries

Official SDKs are available for popular programming languages:

  • Python — pip install zytheron
  • Node.js — npm install @zytheron/sdk
  • Go — go get github.com/zytheron/go-sdk
  • Ruby — gem install zytheron
  • PHP — composer require zytheron/sdk

API Documentation

Full API documentation including interactive examples, response schemas, error codes, and best practices is available at docs.zytheron.com. The documentation includes a sandbox environment for testing API calls without affecting production data.