API Reference

Integrer med Conzent Consent Management Platform. Disse endepunkter driver samtykke banneret, geolocation målretning, samtykke revisionslogning og cookie scanning.

Alle endepunkter er relative til din selvhostede Conzent instans. Erstat basis URL'en med dit faktiske domæne.

Godkendelse

De fleste endepunkter er offentlige — de kaldes fra samtykke banner scriptet der kører på dine besøgendes browsere.

Endepunkter, der accepterer data, bruger en Website Key til at identificere, hvilken side anmodningen tilhører. Find din website nøgle i Conzent dashboardet under Sites.

Svarformat

API-svar bruger to formater afhængigt af endepunktet:

Standard Svar

Bruges af Sundhedstjek og Scan Webhook.

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

Letvægts Svar

Bruges af beacon endepunkter (Sidevisning, Samtykke, Scan Data) for minimal overhead.

{
  "status": "ok"
}

Sundhedstjek

Returnerer sundhedstilstanden for applikationen og bagvedliggende tjenester. Bruges til overvågning, load balancer tjek og Docker sundhedstjek.

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": "degraderet",
    "services": {
      "database": true,
      "redis": false
    }
  }
}

Eksempel

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

Geolocation

Returnerer besøgendes landekode og EU medlemskabsstatus. Bruges af samtykke scriptet til at anvende geo-målrettede reguleringer (GDPR, CCPA).

Svarfelter

Svar

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

Eksempel

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

Sidevisning Beacon

Registrerer sidevisning og banner-læsning begivenheder. Sendes via navigator.sendBeacon() som multipart/form-data. Øger den daglige sidevisnings tæller og buffrer cookie observationer til asynkron behandling.

Anmodningskrop multipart/form-data

Svar

{
  "status": "ok"
}

Eksempel

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

Samtykke Log

Registrerer GDPR samtykke revisionsspor, når en besøgende accepterer, afviser eller tilpasser samtykke. Dette er det primære overholdelses endepunkt.

Anmodningskrop multipart/form-data

Svar

{
  "status": "ok"
}

Eksempel

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"

Scan Data Beacon

Modtager klient-side cookie scan data. Samtykke scriptet opdager cookies i besøgendes browser og rapporterer dem til automatisk kategorisering. Data buffres i Redis og behandles asynkront.

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

Eksempel

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

Modtager scanningsresultater fra eksterne scanner servere, når en cookie scanning er afsluttet. Godkendt via X-Api-Key header, der matcher SCANNER_WEBHOOK_SECRET miljøvariablen.

Headers

Anmodningskrop application/json

Svar

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

Fejl

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

Eksempel

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