مرجع API

API الخاص بـ مراقب العلامة التجارية

راقب المجالات بحثًا عن انتهاك العلامات التجارية وتهديدات محاكاة النطاقات. استخدم هذا المرجع لاختيار عملية ودمج عقد الاستجابة الموثق.

العمليات

GET /v1/brand-monitor عرض مرجع API
POST /v1/brand-monitor عرض مرجع API
DELETE /v1/brand-monitor عرض مرجع API
POST /v1/brand-monitor/scan عرض مرجع API
GET /v1/brand-monitor/status عرض مرجع API
POST /v1/brand-monitor/reset-baseline عرض مرجع API
PUT /v1/brand-monitor/alerts عرض مرجع API

GET /v1/brand-monitor

العملية: getBrandMonitors الوحدات والمصادقة: 1 المصادقة مطلوبة
GET /v1/brand-monitor

حقول الرد

الحقل النوع
brands[] object[]
brands[] object
brands[].domain string
brands[].added_at string
brands[].last_scan_at string | null
brands[].scan_count integer
brands[].registered_typos integer
brands[].new_threats_since_baseline integer
brands[].has_alerts boolean
brands[].scan_status string
total integer
updated_at string

طلب مثال

curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/brand-monitor"

مثال الرد

{
  "brands": [
    {
      "domain": "example.com",
      "added_at": "2026-04-15T12:00:00Z",
      "last_scan_at": "2026-04-15T12:00:00Z",
      "scan_count": 1,
      "registered_typos": 1,
      "new_threats_since_baseline": 1,
      "has_alerts": true,
      "scan_status": "pending"
    }
  ],
  "total": 1,
  "updated_at": "2026-04-15T12:00:00Z"
}

POST /v1/brand-monitor

العملية: createBrandMonitor الوحدات والمصادقة: 3 المصادقة مطلوبة
POST /v1/brand-monitor

معاملات الجسم

المعامل النوع مطلوب
domain string مطلوب
alert_email string اختياري
alert_webhook string اختياري

حقول الرد

الحقل النوع
success boolean
message string
brand object
brand.domain string
brand.baseline_threats integer
brand.scan_status string
initial_scan object | null

طلب مثال

curl -X POST "https://domscan.net/v1/brand-monitor" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -d '{
  "domain": "example.com",
  "alert_email": "[email protected]",
  "alert_webhook": "https://example.com"
}'

مثال الرد

{
  "success": true,
  "message": "string",
  "brand": {
    "domain": "example.com",
    "baseline_threats": 1,
    "scan_status": "pending"
  },
  "initial_scan": {}
}

DELETE /v1/brand-monitor

العملية: deleteBrandMonitor الوحدات والمصادقة: 1 المصادقة مطلوبة
DELETE /v1/brand-monitor

معاملات الاستعلام

المعامل النوع مطلوب
domain string مطلوب

حقول الرد

الحقل النوع
success boolean
message string

طلب مثال

curl -X DELETE "https://domscan.net/v1/brand-monitor?domain=example.com" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -d '{}'

مثال الرد

{
  "success": true,
  "message": "string"
}

POST /v1/brand-monitor/scan

العملية: triggerBrandScan الوحدات والمصادقة: 6 المصادقة مطلوبة
POST /v1/brand-monitor/scan

معاملات الاستعلام

المعامل النوع مطلوب
domain string مطلوب

حقول الرد

الحقل النوع
success boolean
scan object | null
alert object
alert.level string
alert.message string

طلب مثال

curl -X POST "https://domscan.net/v1/brand-monitor/scan?domain=example.com" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -d '{}'

مثال الرد

{
  "success": true,
  "scan": {},
  "alert": {
    "level": "medium",
    "message": "string"
  }
}

GET /v1/brand-monitor/status

العملية: getBrandMonitorStatus الوحدات والمصادقة: 1 المصادقة مطلوبة
GET /v1/brand-monitor/status

معاملات الاستعلام

المعامل النوع مطلوب
domain string مطلوب

حقول الرد

الحقل النوع
brand object
brand.domain string
brand.name string
brand.tld string
brand.added_at string
brand.last_scan_at string | null
brand.scan_count integer
threats object
threats.baseline_count integer
threats.current_count integer
threats.new_since_baseline integer
threats.new_threat_domains[] string[]
threats.all_registered[] string[]
alerts object
alerts.email string | null
alerts.webhook string | null

طلب مثال

curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/brand-monitor/status?domain=example.com"

مثال الرد

{
  "brand": {
    "domain": "example.com",
    "name": "string",
    "tld": "com",
    "added_at": "2026-04-15T12:00:00Z",
    "last_scan_at": "2026-04-15T12:00:00Z",
    "scan_count": 1
  },
  "threats": {
    "baseline_count": 1,
    "current_count": 1,
    "new_since_baseline": 1,
    "new_threat_domains": [
      "example.com"
    ],
    "all_registered": [
      "string"
    ]
  },
  "alerts": {
    "email": "[email protected]",
    "webhook": "string"
  }
}

POST /v1/brand-monitor/reset-baseline

العملية: resetBrandMonitorBaseline الوحدات والمصادقة: 1 المصادقة مطلوبة
POST /v1/brand-monitor/reset-baseline

معاملات الاستعلام

المعامل النوع مطلوب
domain string مطلوب

حقول الرد

الحقل النوع
success boolean
message string

طلب مثال

curl -X POST "https://domscan.net/v1/brand-monitor/reset-baseline?domain=example.com" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -d '{}'

مثال الرد

{
  "success": true,
  "message": "string"
}

PUT /v1/brand-monitor/alerts

العملية: updateBrandMonitorAlerts الوحدات والمصادقة: 1 المصادقة مطلوبة
PUT /v1/brand-monitor/alerts

معاملات الجسم

المعامل النوع مطلوب
domain string مطلوب
alert_email string | null اختياري
alert_webhook string | null اختياري

حقول الرد

الحقل النوع
success boolean
message string

طلب مثال

curl -X PUT "https://domscan.net/v1/brand-monitor/alerts" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -d '{
  "domain": "example.com",
  "alert_email": "[email protected]",
  "alert_webhook": "https://example.com"
}'

مثال الرد

{
  "success": true,
  "message": "string"
}

موارد المرجع