API Référence

Intégrez-vous à la plateforme de gestion de consentement Conzent. Ces points de terminaison alimentent la bannière de consentement, le ciblage géolocalisé, l'audit de consentement et le scan des cookies.

Tous les points de terminaison sont relatifs à votre instance Conzent auto-hébergée. Remplacez l'URL de base par votre domaine réel.

Authentification

La plupart des points de terminaison sont publics — ils sont appelés depuis le script de la bannière de consentement s'exécutant sur les navigateurs de vos visiteurs.

Les points de terminaison qui acceptent des données utilisent une Clé de site pour identifier à quel site appartient la demande. Trouvez votre clé de site dans le tableau de bord Conzent sous Sites.

Format de réponse

Les réponses API utilisent deux formats selon le point de terminaison :

Réponse standard

Utilisé par la vérification de l'état et le webhook de scan.

{
  "success": true,
  "data": {
    "status": "ok"
  }
}

Réponse légère

Utilisé par les points de terminaison de balise (Vue de page, Consentement, Données de scan) pour un minimum de surcharge.

{
  "status": "ok"
}

Vérification de l'état

Retourne l'état de santé de l'application et des services de support. Utilisé pour la surveillance, les vérifications de l'équilibreur de charge et les sondes de santé Docker.

Réponse

{
  "success": true,
  "data": {
    "status": "ok",
    "services": {
      "database": true,
      "redis": true
    },
    "environment": "production",
    "timestamp": "2026-03-16T12:00:00+00:00"
  }
}

{
  "success": true,
  "data": {
    "status": "degraded",
    "services": {
      "database": true,
      "redis": false
    }
  }
}

Exemple

curl https://your-instance.example.com/health

Géolocalisation

Retourne le code du pays du visiteur et le statut d'adhésion à l'UE. Utilisé par le script de consentement pour appliquer des réglementations géolocalisées (GDPR, CCPA).

Champs de réponse

Réponse

{
  "country": "dk",
  "in_eu": true
}

Exemple

curl https://your-instance.example.com/api/v1/geo_ip

Balise de vue de page

Enregistre les événements de vue de page et de chargement de bannière. Envoyé via navigator.sendBeacon() en tant que multipart/form-data. Incrémente le compteur de vues de page quotidien et met en mémoire tampon les observations de cookies pour un traitement asynchrone.

Corps de la demande multipart/form-data

Réponse

{
  "status": "ok"
}

Exemple

curl -X POST https://your-instance.example.com/api/v1/log \
  -F "key=YOUR_WEBSITE_KEY" \
  -F "request_type=banner_load" \
  -F "log_time=$(date +%s)"

Journal de consentement

Enregistre la trace d'audit de consentement GDPR lorsqu'un visiteur accepte, rejette ou personnalise le consentement. C'est le point de terminaison principal de conformité.

Corps de la demande multipart/form-data

Réponse

{
  "status": "ok"
}

Exemple

curl -X POST https://your-instance.example.com/api/v1/consent \
  -F "key=YOUR_WEBSITE_KEY" \
  -F "conzent_id=a1b2c3d4e5f6..." \
  -F 'log=[{"category":"analytics","consented":true}]' \
  -F "consented_domain=example.com" \
  -F "language=en" \
  -F "country=dk"

Balise de données de scan

Reçoit les données de scan de cookies côté client. Le script de consentement détecte les cookies sur le navigateur du visiteur et les signale pour une catégorisation automatique. Les données sont mises en mémoire tampon dans Redis et traitées de manière asynchrone.

Corps de la demande multipart/form-data

Structure de la charge utile

{
  "scan_id": 123,
  "action": "runscan",
  "scan_url": "https://example.com/",
  "consent_phase": "pre_consent",
  "data": {
    "cookies": [
      { "name": "_ga", "domain": ".example.com" }
    ]
  }
}

Réponse

{
  "status": "ok"
}

Exemple

curl -X POST https://your-instance.example.com/api/v1/scan_data \
  -F "key=YOUR_WEBSITE_KEY" \
  -F 'payload={"scan_id":123,"action":"runscan","scan_url":"https://example.com/"}'

Webhook de scanner

Reçoit les résultats de scan des serveurs de scanner externes lorsqu'un scan de cookie est terminé. Authentifié via l'en-tête X-Api-Key correspondant à la variable d'environnement SCANNER_WEBHOOK_SECRET.

En-têtes

Corps de la demande application/json

Réponse

{
  "success": true,
  "data": {
    "status": "processed"
  }
}

Erreur

{
  "success": false,
  "error": "Non autorisé"
}

Exemple

curl -X POST https://your-instance.example.com/api/v1/scan-webhook \
  -H "X-Api-Key: YOUR_SCANNER_WEBHOOK_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "webhook",
    "scan_id": 456,
    "scan_url": "https://example.com/",
    "data": {
      "cookies": [
        {"name": "_ga", "domain": ".example.com", "category": "analytics"}
      ]
    }
  }'