API Referens

Integrera med Conzent Consent Management Platform. Dessa slutpunkter driver samtyckesbanner, geolokalisering, samtyckesgranskning och kakskanning.

Alla slutpunkter är relativa till din självhostade Conzent-instans. Byt ut bas-URL:en mot din faktiska domän.

Autentisering

De flesta slutpunkter är offentliga — de anropas från samtyckesbanner-skriptet som körs i dina besökares webbläsare.

Slutpunkter som accepterar data använder en Webbplatsnyckel för att identifiera vilken webbplats begäran tillhör. Hitta din webbplatsnyckel i Conzent-instrumentpanelen under Webbplatser.

Svarformat

API-svar använder två format beroende på slutpunkten:

Standard Svar

Används av Hälsokontroll och Skanningswebhook.

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

Lättvikts Svar

Används av signaler (Sidvisning, Samtycke, Skanningsdata) för minimal overhead.

{
  "status": "ok"
}

Hälsokontroll

Returnerar hälsostatus för applikationen och stödjande tjänster. Används för övervakning, lastbalanseringskontroller och Docker hälsokontroller.

Svar

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

Exempel

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

Geolokalisering

Returnerar besökarens landskod och EU-medlemskapsstatus. Används av samtyckesskriptet för att tillämpa geotargeterade regler (GDPR, CCPA).

Svarsfält

Svar

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

Exempel

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

Sidvisningssignal

Registrerar sidvisningar och bannerladdningsevent. Skickas via navigator.sendBeacon() som multipart/form-data. Ökar den dagliga sidvisningsräknaren och buffrar kakobservationer för asynkron bearbetning.

Begärningskropp multipart/form-data

Svar

{
  "status": "ok"
}

Exempel

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

Samtyckeslogg

Registrerar GDPR-samtyckesgranskningen när en besökare accepterar, avvisar eller anpassar samtycke. Detta är den primära efterlevnadsslutpunkten.

Begärningskropp multipart/form-data

Svar

{
  "status": "ok"
}

Exempel

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"

Skanningsdatabanner

Tar emot klientbaserad kakskanningsdata. Samtyckesskriptet upptäcker kakor i besökarens webbläsare och rapporterar dem för automatisk kategorisering. Data buffras i Redis och bearbetas asynkront.

Begärningskropp multipart/form-data

Payload-struktur

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

Svar

{
  "status": "ok"
}

Exempel

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

Tar emot skanningsresultat från externa skannerservrar när en kakskanning är klar. Autentiseras via X-Api-Key-huvudet som matchar SCANNER_WEBHOOK_SECRET-miljövariabeln.

Huvuden

Begärningskropp application/json

Svar

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

Fel

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

Exempel

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