Référence Développeur

Surveillance de marque

API DomScan : Surveillance continue de la protection de la marque. Suivez les menaces de typosquattage et les tentatives d'usurpation d'identité de marque.

Surveillance de marque

Surveillance continue de la protection de la marque. Suivez les menaces de typosquattage et les tentatives d'usurpation d'identité de marque.

GET /v1/brand-monitor

Obtenez toutes les marques surveillées et leur statut de menace actuel.

Exemple de Réponse

{
                "brands": [
                {
                "domain": "mycompany.com",
                "added_at": "2024-03-01T12:00:00Z",
                "last_scan_at": "2024-03-14T08:30:00Z",
                "scan_count": 6,
                "registered_typos": 3,
                "new_threats_since_baseline": 1,
                "has_alerts": true
                }
                ],
                "total": 1,
                "updated_at": "2024-03-14T08:30:00Z"
                }

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

POST /v1/brand-monitor

Créez une nouvelle surveillance de marque.

Corps de la requête

{
                "domain": "mycompany.com",
                "alert_email": "security@example.com"
                }

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 Réponse

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

POST /v1/brand-monitor/scan?domain=mycompany.com

Lancez immédiatement une analyse pour une marque surveillée.

Champs de Réponse

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

Exemple de Réponse

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

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

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": "alerts@example.com",
    "webhook": "string"
  }
}

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

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": "alerts@example.com",
  "alert_webhook": "https://example.com"
}'

Exemple de Réponse

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