API Referanse

Integrer med Conzent Samtykkehåndteringsplattform. Disse endepunktene driver samtykkebanneret, geolokalisering målretting, samtykke revisjonslogging og informasjonskapselskanning.

Alle endepunkter er relative til din selvhostede Conzent-instans. Erstatt grunnleggende URL med ditt faktiske domene.

Autentisering

De fleste endepunkter er offentlige — de kalles fra samtykkebanner-skriptet som kjører på besøkendes nettlesere.

Endepunkter som aksepterer data bruker en Nettside-nøkkel for å identifisere hvilken side forespørselen tilhører. Finn nettsiden din nøkkel i Conzent-dashbordet under Nettsteder.

Responsformat

API-responser bruker to formater avhengig av endepunktet:

Standard Respons

Brukes av Helsekontroll og Skann Webhook.

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

Lettvektsrespons

Brukes av beacon-endepunkter (Sidevisning, Samtykke, Skann Data) for minimal overhead.

{
  "status": "ok"
}

Helsekontroll

Returnerer helsestatusen til applikasjonen og støttetjenester. Brukes til overvåking, lastbalanseringskontroller og Docker helseprober.

Respons

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

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

Eksempel

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

Geolokalisering

Returnerer besøkendes landskode og EU-medlemskapsstatus. Brukes av samtykkeskriptet for å anvende geo-målrettede forskrifter (GDPR, CCPA).

Responsfelt

Respons

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

Eksempel

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

Sidevisning Beacon

Registrerer sidevisning og banner-laste hendelser. Sendes via navigator.sendBeacon() som multipart/form-data. Øker den daglige sidevisningstelleren og bufferer informasjonskapselobservasjoner for asynkron behandling.

Forespørsel Kropp multipart/form-data

Respons

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

Registrerer GDPR-samtykke revisjonsspor når en besøkende aksepterer, avviser eller tilpasser samtykke. Dette er det primære samsvars-endepunktet.

Forespørsel Kropp multipart/form-data

Respons

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

Skann Data Beacon

Mottar klient-side informasjonskapselskann data. Samtykkeskriptet oppdager informasjonskapsler i besøkendes nettleser og rapporterer dem for automatisk kategorisering. Data buffres i Redis og behandles asynkront.

Forespørsel Kropp 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" }
    ]
  }
}

Respons

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

Mottar skanneresultater fra eksterne skanner-servere når en informasjonskapselskanning er fullført. Autentisert via X-Api-Key header som samsvarer med SCANNER_WEBHOOK_SECRET miljøvariabel.

Headere

Forespørsel Kropp application/json

Respons

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

Feil

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

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