Inizia gratisDashboard
Documentazione

L'API

L'API permette ai tuoi strumenti di fare quello che altrimenti faresti nella dashboard: leggere le scelte, rispondere a un visitatore che chiede a cosa ha acconsentito e pubblicare un sito. È inclusa da dieci siti a pagamento in su.

Chiavi

Un proprietario o un amministratore crea le chiavi in Impostazioni, Chiavi API. Una chiave inizia con cmk_ e appartiene a una sola organizzazione. La mostriamo una volta sola e salviamo solo un'impronta, quindi copiala subito. Sempre lì puoi revocare una chiave: gli strumenti che la usano smettono subito di funzionare.

Invia la chiave con ogni richiesta:

curl https://cookiemark.com/api/v1/sites \
  -H "Authorization: Bearer cmk_..."

Una chiave può fare 120 richieste al minuto. Oltre questo limite ricevi lo stato 429: aspetta un minuto e continua.

Elencare i tuoi siti

GET /api/v1/sites restituisce tutti i siti dell'organizzazione con ID, dominio, chiave dello script, stato e versione online.

GET /api/v1/sites/{id}/consents restituisce le scelte, dalla più recente. Accetta questi parametri:

ParametroCosa fa
since, untilSolo le scelte in questo periodo, come date ISO, per esempio 2026-10-01.
limitQuante scelte, fino a 1.000. Il valore predefinito è 100.
beforePer la pagina successiva: il valore di next_before della risposta precedente, così com'è arrivato. Nell'ultima pagina è vuoto.

Ogni scelta contiene l'ID di consenso, l'azione, le tre categorie, il paese, la lingua, la pagina, la versione del banner e l'ora. Gli indirizzi IP abbreviati e i dettagli del browser restano nella dashboard.

GET /api/v1/consents/{consent_id} restituisce tutte le scelte fatte con un ID di consenso, su qualsiasi sito dell'organizzazione. Usalo quando un visitatore ti indica l'ID dalla sua finestra delle preferenze e chiede a cosa ha acconsentito.

Vedere l'ultima scansione

GET /api/v1/sites/{id}/scan restituisce i risultati, i controlli, i cookie e gli ID di tracciamento (come gli ID di Tag Manager e del tag Google) dell'ultima scansione completata.

Pubblicare un sito

POST /api/v1/sites/{id}/publish mette online la bozza attuale, come il pulsante Pubblica. Puoi inviare una nota, che compare nell'elenco delle versioni del sito:

curl -X POST https://cookiemark.com/api/v1/sites/{id}/publish \
  -H "Authorization: Bearer cmk_..." \
  -H "Content-Type: application/json" \
  -d '{"note": "New cookie list after the October scan"}'

La risposta contiene il numero della nuova versione.

Errori

Ogni errore arriva come JSON con un campo error in inglese semplice.

  • 400: una data, un cursore o un ID di consenso non ha il formato giusto.
  • 401: la chiave manca, è sbagliata o è stata revocata.
  • 403: l'organizzazione non ha l'API, che è inclusa da dieci siti a pagamento in su.
  • 404: il sito non fa parte di questa organizzazione.
  • 409: il sito non si può pubblicare, perché è archiviato o perché tutti i siti a pagamento sono già online.
  • 429: più di 120 richieste in un minuto.
  • 500: qualcosa è andato storto da parte nostra; riprova tra un minuto.