Management API

Administrér CookieHub i stor skala med Management API’et.

Opret og administrér domæner, læs og opdatér deres samtykkekonfiguration, kør cookiescanninger og hent poster fra samtykkeloggen fra dine egne backend-systemer – i stedet for at gentage de samme ændringer i CookieHub Dashboard.

  • REST API med JSON
  • Domæner og domæneindstillinger
  • Enterprise API-legitimationsoplysninger
Overblik

Ét API til at administrere CookieHub-konfigurationen på tværs af din portefølje.

CookieHub Management API er et API til samtykkeadministration for backend-systemer. Det er bygget til udviklere, platformteams og DevOps- eller infrastrukturteams – og til organisationer, der administrerer flere CookieHub-domæner og vil styre konto- og domænekonfigurationen i kode.

I stedet for at gentage den samme ændring domæne for domæne i Dashboard kalder dine egne værktøjer API’et: de opretter domæner, læser og opdaterer deres indstillinger og holder konfigurationen ensartet på tværs af de domæner, du administrerer.

  • Domæneadministration

    Få en oversigt over domænerne på din konto, opret nye, slå et domæne op via dets ID, og fjern domæner, du ikke længere har brug for.

  • Automatiseret konfiguration

    Læs og opdatér et domænes indstillinger, sprog og regioner fra kode. Indstillinger, du opdaterer via API’et, bliver publiceret på domænet.

  • Backend-integrationer

    Forbind CookieHub med dine værktøjer til onboarding, deployment og administration – med forespørgsler på serversiden og Enterprise API-legitimationsoplysninger.

API-ressourcer

De ressourcer, din backend kan administrere.

Management API’et er et REST API, der sender og modtager JSON. Brugere og abonnementer hører til din konto; alt andet hører til et domæne.

  • Brugere: se, hvilke brugere der er tilknyttet din konto, eller hent én via ID
  • Abonnementer: se, hvilke CookieHub-abonnementer der er tilgængelige for din konto
  • Domæner: få en oversigt over domænerne, opret, hent og slet domæner, og nulstil samtykke, så alle besøgende bliver spurgt igen
  • Indstillinger, sprog og regioner: læs og opdatér et domænes indstillinger, dialogens tekster pr. sprog og domænets regioner
  • Scanninger: bestil en ny cookiescanning, og læs resultaterne, herunder de fundne cookies
  • Samtykkelog: bestil et batch af logposter efter datointerval eller samtykketoken, og hent derefter batchens poster

Cookies har ikke et selvstændigt endpoint: de returneres i en scannings resultater. API-referencen dokumenterer alle endpoints, parametre og svar.

Se API-referencen
Domæneindstillinger

Hent og opdatér domænekonfigurationen programmatisk.

Hvert domænes indstillinger er tilgængelige som ét JSON-objekt. Hent de aktuelle indstillinger, ændr de værdier, du har brug for, og send dem tilbage med en PATCH-forespørgsel – API’et opdaterer domænet og publicerer ændringerne.

  • general: hvor og hvor længe den besøgendes valg gemmes
  • language: dialogens standardsprog og registrering af browserens sprog
  • crawler: cookiescanneren, dens start-URL, sidegrænse og automatisk publicering
  • blocker: den automatiske cookieblokering og pladsholdere for blokerede iframes
  • gtm og gcm: Google Tag Manager-events og Google Consent Mode
  • ui: samtykkedialogens udseende, farver og links

Andre kategorier dækker geolokation, registrering i samtykkeloggen, fjernelse af cookies og den indlejrede cookiedeklaration. Regioner har deres egne endpoints, så du kan tilføje, opdatere eller fjerne et domænes regioner separat.

Domæneindstillinger i API-referencen
Godkendelse

Enterprise API-legitimationsoplysninger, der bliver på dine servere.

Opret dine Enterprise API-legitimationsoplysninger i CookieHub Dashboard, og godkend hver forespørgsel via Authorization-headeren. Se API-referencen for det aktuelle godkendelsesformat og implementeringsdetaljer.

  1. Opret API-legitimationsoplysninger i Dashboard
  2. Gem dem i din backend
  3. Godkend hver forespørgsel i Authorization-headeren
Godkendelse i API-referencen
  • Hold legitimationsoplysningerne på serversiden

    API-legitimationsoplysninger giver administrativ adgang til din CookieHub-konto. Opbevar dem i din backend eller et lager til hemmeligheder, og læg dem aldrig i frontend-JavaScript, anden browserkode eller et offentligt repository.

  • Administrér nøgler i Dashboard

    Enterprise-konti har en sektion med API-nøgler i Konto-menuen. Den viser hver nøgles navn, oprettelsesdato og seneste brug, og her kan du oprette nye nøgler og tilbagekalde dem, du ikke længere har brug for.

Automatiserings-workflows

Få CookieHub-administrationen ind i de værktøjer, du allerede bruger.

Hvert workflow er en række almindelige REST-forespørgsler, der køres fra dine egne scripts, interne værktøjer eller CI/CD-pipelines – for eksempel et deployment-trin, der anvender de indstillinger, dit team har i versionsstyring. Domæneforespørgsler gælder ét domæne ad gangen.

Fuld API-reference
  • Opret domæner under onboarding

    Når dit onboarding-workflow godkender et nyt website, opretter du dets CookieHub-domæne og henter dets detaljer, herunder den domænekode, CookieHub installeres med.

    • POST/domain
    • GET/domain/{domainId}
  • Hent domænekonfigurationen

    Læs indstillingerne for ethvert domæne på din konto, for eksempel for at sammenligne dem med din godkendte opsætning eller vise dem i et internt værktøj.

    • GET/domain
    • GET/domain/{domainId}/settings
  • Opdatér indstillinger fra interne værktøjer

    Ændr værdier som sprogregistrering, cookieblokering eller Google Consent Mode fra dine egne admin-værktøjer, og opdatér dialogens tekster for et sprog.

    • PATCH/domain/{domainId}/settings
    • PATCH/domain/{domainId}/language/{languageId}
  • Hold den godkendte konfiguration synkroniseret

    Anvend de samme godkendte indstillinger på alle de domæner, du administrerer: hent en oversigt over domænerne, og opdatér derefter hvert domænes indstillinger på skift.

    • GET/domain
    • PATCH/domain/{domainId}/settings
  • Kør cookiescanninger

    Bestil en ny cookiescanning for et domæne, og læs resultaterne, herunder de scannede sider og de fundne cookies.

    • POST/domain/{domainId}/scan
    • GET/domain/{domainId}/scan/{scanId}
  • Hent poster fra samtykkeloggen

    Bestil et batch fra samtykkeloggen for et datointerval eller en besøgendes samtykketoken, og hent dets poster, når batchen er behandlet.

    • POST/domain/{domainId}/consent-log
    • GET/domain/{domainId}/consent-log/{batchId}
FAQ

Spørgsmål om Management API’et, besvaret.

Et REST API til at administrere din CookieHub-konto og dine domæner fra dine egne systemer. Det sender og modtager JSON og lader dig oprette, opdatere og hente oplysninger om domæner, læse og opdatere deres indstillinger, sprog og regioner, bestille cookiescanninger og hente poster fra samtykkeloggen.

Management API’et er tilgængeligt for Enterprise-kunder. API-legitimationsoplysninger oprettes i sektionen API-nøgler i CookieHub Dashboard, som Enterprise-konti åbner fra Konto-menuen.

Brugere og abonnementer på din konto og for hvert domæne: dets detaljer, indstillinger, sprog og regioner, cookiescanninger og deres resultater, batches fra samtykkeloggen og en nulstilling af samtykke, der spørger alle besøgende igen. Cookies returneres i en scannings resultater frem for via et selvstændigt endpoint.

Opret dine Enterprise API-legitimationsoplysninger i CookieHub Dashboard, og godkend hver forespørgsel via Authorization-headeren. API-referencen beskriver det aktuelle godkendelsesformat og implementeringsdetaljer.

Ja. Du kan få en oversigt over alle domæner på din konto, oprette nye og arbejde med hvert af dem via dets domæne-ID. Domæneforespørgsler gælder ét domæne ad gangen, så for at anvende en ændring på flere domæner sender din kode en forespørgsel for hvert domæne.

Ja. En GET-forespørgsel returnerer et domænes indstillinger som JSON, herunder indstillingerne for general, language, crawler, blocker, Google Tag Manager, Google Consent Mode og UI. En PATCH-forespørgsel opdaterer indstillingerne og publicerer ændringerne. Sprog og regioner har deres egne endpoints.

Ja. Bestil et batch fra samtykkeloggen for et domæne efter datointerval eller efter en besøgendes samtykketoken. Det kan tage et par minutter at danne et batch, så du henter dets poster, når det er behandlet. Batches, du ikke længere har brug for, kan slettes.

Nej. Management API’et er til brug på serversiden. Dets legitimationsoplysninger giver administrativ adgang til din CookieHub-konto, så de skal blive på dine servere og må aldrig indgå i frontend-JavaScript eller anden browserkode. Brug JavaScript API’et til at arbejde med samtykke i browseren.

Management API’et kører på dine servere og administrerer konto- og domænekonfigurationen – domæner, indstillinger, scanninger og samtykkelog – med Enterprise API-legitimationsoplysninger. JavaScript API’et kører i den besøgendes browser via window.cookiehub: det læser den besøgendes samtykketilstand, lader din kode reagere på samtykke-events og åbner samtykkedialogen og indstillingerne.

Det er et RESTful API, der bruger HTTP-metoderne GET, POST, PATCH og DELETE med JSON i forespørgsler og svar, og det er dokumenteret som en OpenAPI-specifikation.

CookieHub API-referencen på SwaggerHub dokumenterer hvert endpoint, dets parametre, forespørgsels- og svarformater og det aktuelle godkendelsesformat. Knapperne »Se API-dokumentationen« på denne side åbner den.

Kom i gang

Automatisér CookieHub-administrationen i hele din stack.

Forbind dine interne systemer med CookieHub, og administrér domænekonfigurationen programmatisk.