API Viite

Integroi Conzent Suostumushallintapalvelun kanssa. Nämä päätepisteet ohjaavat suostumusbanneria, geolokaatio kohdistusta, suostumusarkistointia ja evästeiden skannausta.

Kaikki päätepisteet ovat suhteellisia itse isännöidylle Conzent-instanssillesi. Korvaa perus-URL todellisella verkkotunnuksellasi.

Todennus

Useimmat päätepisteet ovat julkisia — niitä kutsutaan suostumusbannerin skriptistä kävijöidesi selaimissa.

Päätepisteet, jotka hyväksyvät tietoja, käyttävät Verkkosivuston avainta tunnistaakseen, mihin sivustoon pyyntö kuuluu. Löydä verkkosivustosi avain Conzentin hallintapaneelista kohdasta Sivustot.

Vastausmuoto

API-vastaukset käyttävät kahta muotoa riippuen päätepisteestä:

Standardivastaus

Käytetään Terveystarkistuksessa ja Skannaus Webhookissa.

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

Kevyt vastaus

Käytetään beacon-päätepisteissä (Sivunäkymä, Suostumus, Skannausdata) minimaalisen ylikuormituksen vuoksi.

{
  "status": "ok"
}

Terveystarkistus

Palauttaa sovelluksen ja taustapalveluiden terveysstatuksen. Käytä valvontaan, kuormantasaustarkistuksiin ja Dockerin terveysmittauksiin.

Vastaus

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

Esimerkki

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

Geolokaatio

Palauttaa kävijän maan koodin ja EU-jäsenyystilan. Käytetään suostumus-skriptissä geokohdistettujen sääntöjen soveltamiseen (GDPR, CCPA).

Vastauskentät

Vastaus

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

Esimerkki

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

Sivunäkymä Beacon

Kirjaa sivunäkymä- ja bannerin lataustapahtumat. Lähetetään navigator.sendBeacon() muodossa multipart/form-data. Lisää päivittäistä sivunäkymä-laskuria ja puskee evästeobservaatioita asynkroniseen käsittelyyn.

Pyyntöruumis multipart/form-data

Vastaus

{
  "status": "ok"
}

Esimerkki

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

Suostumuslokki

Kirjaa GDPR-suostumuksen audit trail, kun kävijä hyväksyy, hylkää tai mukauttaa suostumusta. Tämä on ensisijainen vaatimustenmukaisuuspäätepiste.

Pyyntöruumis multipart/form-data

Vastaus

{
  "status": "ok"
}

Esimerkki

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"

Skannausdata Beacon

Vastaanottaa asiakaspuolen evästeiden skannausdataa. Suostumus-skripti tunnistaa evästeet kävijän selaimessa ja raportoi ne automaattista luokittelua varten. Data pusketaan Redisissä ja käsitellään asynkronisesti.

Pyyntöruumis multipart/form-data

Payload-rakenne

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

Vastaus

{
  "status": "ok"
}

Esimerkki

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

Skannerin Webhook

Vastaanottaa skannauksen tulokset ulkoisilta skanneripalvelimilta, kun evästeiden skannaus on valmis. Todennettu X-Api-Key -otsikolla, joka vastaa SCANNER_WEBHOOK_SECRET ympäristömuuttujaa.

Otsikot

Pyyntöruumis application/json

Vastaus

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

Virhe

{
  "success": false,
  "error": "Ei valtuutettu"
}

Esimerkki

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