Référence API

API Moniteur de Marque

Surveillez les domaines pour l'infraction de marque et les menaces de typosquattage. Utilisez cette référence pour choisir une opération et intégrer son contrat de réponse documenté.

Opérations

GET /v1/brand-monitor Voir la référence API
POST /v1/brand-monitor Voir la référence API
DELETE /v1/brand-monitor Voir la référence API
POST /v1/brand-monitor/scan Voir la référence API
GET /v1/brand-monitor/status Voir la référence API
POST /v1/brand-monitor/reset-baseline Voir la référence API
PUT /v1/brand-monitor/alerts Voir la référence API

GET /v1/brand-monitor

Opération: getBrandMonitors Crédits et authentification: 1 Authentification requise
GET /v1/brand-monitor

Champs de Réponse

Champ Type
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

Exemple de Requête

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

Exemple de Réponse

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

Opération: createBrandMonitor Crédits et authentification: 3 Authentification requise
POST /v1/brand-monitor

Paramètres du Corps

Paramètre Type requis
domain string requis
alert_email string optionnel
alert_webhook string optionnel

Champs de Réponse

Champ Type
success boolean
message string
brand object
brand.domain string
brand.baseline_threats integer
brand.scan_status string
initial_scan object | null

Exemple de Requête

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

Exemple de Réponse

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

DELETE /v1/brand-monitor

Opération: deleteBrandMonitor Crédits et authentification: 1 Authentification requise
DELETE /v1/brand-monitor

Paramètres de Requête

Paramètre Type requis
domain string requis

Champs de Réponse

Champ Type
success boolean
message string

Exemple de Requête

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

Exemple de Réponse

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

POST /v1/brand-monitor/scan

Opération: triggerBrandScan Crédits et authentification: 6 Authentification requise
POST /v1/brand-monitor/scan

Paramètres de Requête

Paramètre Type requis
domain string requis

Champs de Réponse

Champ Type
success boolean
scan object | null
alert object
alert.level string
alert.message string

Exemple de Requête

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

Exemple de Réponse

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

GET /v1/brand-monitor/status

Opération: getBrandMonitorStatus Crédits et authentification: 1 Authentification requise
GET /v1/brand-monitor/status

Paramètres de Requête

Paramètre Type requis
domain string requis

Champs de Réponse

Champ Type
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

Exemple de Requête

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

Exemple de Réponse

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

Opération: resetBrandMonitorBaseline Crédits et authentification: 1 Authentification requise
POST /v1/brand-monitor/reset-baseline

Paramètres de Requête

Paramètre Type requis
domain string requis

Champs de Réponse

Champ Type
success boolean
message string

Exemple de Requête

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

Exemple de Réponse

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

PUT /v1/brand-monitor/alerts

Opération: updateBrandMonitorAlerts Crédits et authentification: 1 Authentification requise
PUT /v1/brand-monitor/alerts

Paramètres du Corps

Paramètre Type requis
domain string requis
alert_email string | null optionnel
alert_webhook string | null optionnel

Champs de Réponse

Champ Type
success boolean
message string

Exemple de Requête

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

Exemple de Réponse

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

Ressources de référence