Riferimento API

API Monitor marchio

Monitora i domini per la violazione del marchio e le minacce di typosquatting. Usa questo riferimento per scegliere un’operazione e integrare il relativo contratto di risposta documentato.

Operazioni

GET /v1/brand-monitor Vedi il riferimento API
POST /v1/brand-monitor Vedi il riferimento API
DELETE /v1/brand-monitor Vedi il riferimento API
POST /v1/brand-monitor/scan Vedi il riferimento API
GET /v1/brand-monitor/status Vedi il riferimento API
POST /v1/brand-monitor/reset-baseline Vedi il riferimento API
PUT /v1/brand-monitor/alerts Vedi il riferimento API

GET /v1/brand-monitor

Operazione: getBrandMonitors Crediti e autenticazione: 1 Autenticazione richiesta
GET /v1/brand-monitor

Campi di risposta

Campo Tipo
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

Richiesta di esempio

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

Risposta di esempio

{
  "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

Operazione: createBrandMonitor Crediti e autenticazione: 3 Autenticazione richiesta
POST /v1/brand-monitor

Parametri del corpo

Parametro Tipo obbligatorio
domain string obbligatorio
alert_email string facoltativo
alert_webhook string facoltativo

Campi di risposta

Campo Tipo
success boolean
message string
brand object
brand.domain string
brand.baseline_threats integer
brand.scan_status string
initial_scan object | null

Richiesta di esempio

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"
}'

Risposta di esempio

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

DELETE /v1/brand-monitor

Operazione: deleteBrandMonitor Crediti e autenticazione: 1 Autenticazione richiesta
DELETE /v1/brand-monitor

Parametri di query

Parametro Tipo obbligatorio
domain string obbligatorio

Campi di risposta

Campo Tipo
success boolean
message string

Richiesta di esempio

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 '{}'

Risposta di esempio

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

POST /v1/brand-monitor/scan

Operazione: triggerBrandScan Crediti e autenticazione: 6 Autenticazione richiesta
POST /v1/brand-monitor/scan

Parametri di query

Parametro Tipo obbligatorio
domain string obbligatorio

Campi di risposta

Campo Tipo
success boolean
scan object | null
alert object
alert.level string
alert.message string

Richiesta di esempio

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 '{}'

Risposta di esempio

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

GET /v1/brand-monitor/status

Operazione: getBrandMonitorStatus Crediti e autenticazione: 1 Autenticazione richiesta
GET /v1/brand-monitor/status

Parametri di query

Parametro Tipo obbligatorio
domain string obbligatorio

Campi di risposta

Campo Tipo
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

Richiesta di esempio

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

Risposta di esempio

{
  "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

Operazione: resetBrandMonitorBaseline Crediti e autenticazione: 1 Autenticazione richiesta
POST /v1/brand-monitor/reset-baseline

Parametri di query

Parametro Tipo obbligatorio
domain string obbligatorio

Campi di risposta

Campo Tipo
success boolean
message string

Richiesta di esempio

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 '{}'

Risposta di esempio

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

PUT /v1/brand-monitor/alerts

Operazione: updateBrandMonitorAlerts Crediti e autenticazione: 1 Autenticazione richiesta
PUT /v1/brand-monitor/alerts

Parametri del corpo

Parametro Tipo obbligatorio
domain string obbligatorio
alert_email string | null facoltativo
alert_webhook string | null facoltativo

Campi di risposta

Campo Tipo
success boolean
message string

Richiesta di esempio

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"
}'

Risposta di esempio

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

Risorse di riferimento