API Referentie

Integreer met het Conzent Toestemmingsbeheerplatform. Deze eindpunten ondersteunen de toestemmingsbanner, geolocatie-targeting, toestemmingsauditlogging en cookie-scanning.

Alle eindpunten zijn relatief ten opzichte van uw zelf-gehoste Conzent-instantie. Vervang de basis-URL door uw werkelijke domein.

Authenticatie

De meeste eindpunten zijn publiek — ze worden aangeroepen vanuit het script van de toestemmingsbanner dat draait op de browsers van uw bezoekers.

Eindpunten die gegevens accepteren, gebruiken een Website Sleutel om te identificeren bij welke site het verzoek hoort. Vind uw website sleutel in het Conzent-dashboard onder Sites.

Antwoordformaat

API-antwoorden gebruiken twee formaten, afhankelijk van het eindpunt:

Standaard Antwoord

Gebruikt door Gezondheidscontrole en Scan Webhook.

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

Lichtgewicht Antwoord

Gebruikt door beacon-eindpunten (Paginaweergave, Toestemming, Scangegevens) voor minimale overhead.

{
  "status": "ok"
}

Gezondheidscontrole

Geeft de gezondheidsstatus van de applicatie en de achterliggende diensten terug. Gebruik voor monitoring, load balancer controles en Docker gezondheidscontroles.

Antwoord

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

Voorbeeld

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

Geolocatie

Geeft de landcode en de EU-lidmaatschapsstatus van de bezoeker terug. Gebruikt door het toestemmingsscript om geo-gerichte regelgeving toe te passen (GDPR, CCPA).

Antwoordvelden

Antwoord

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

Voorbeeld

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

Paginaweergave Beacon

Registreert paginaweergave- en banner-laad evenementen. Verzendt via navigator.sendBeacon() als multipart/form-data. Verhoogt de dagelijkse paginaweergave teller en buffert cookie-observaties voor asynchrone verwerking.

Aanvraagbody multipart/form-data

Antwoord

{
  "status": "ok"
}

Voorbeeld

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

Toestemmingslog

Registreert het GDPR-toestemmingsauditpad wanneer een bezoeker toestemming accepteert, afwijst of aanpast. Dit is het primaire compliance-eindpunt.

Aanvraagbody multipart/form-data

Antwoord

{
  "status": "ok"
}

Voorbeeld

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"

Scangegevens Beacon

Ontvangt client-side cookie scan gegevens. Het toestemmingsscript detecteert cookies in de browser van de bezoeker en rapporteert deze voor automatische categorisatie. Gegevens worden gebufferd in Redis en asynchroon verwerkt.

Aanvraagbody multipart/form-data

Payloadstructuur

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

Antwoord

{
  "status": "ok"
}

Voorbeeld

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

Scanner Webhook

Ontvangt scanresultaten van externe scannerservers wanneer een cookie-scan is voltooid. Geauthenticeerd via X-Api-Key header die overeenkomt met de SCANNER_WEBHOOK_SECRET omgevingsvariabele.

Headers

Aanvraagbody application/json

Antwoord

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

Fout

{
  "success": false,
  "error": "Unauthorized"
}

Voorbeeld

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