Commencer gratuitementTableau de bord
Documentation

L’API

L’API permet à vos propres outils de faire ce que vous feriez autrement dans le tableau de bord : lire les choix, répondre à un visiteur qui demande ce qu’il a accepté, et publier un site. Elle est incluse à partir de dix sites payants.

Clés

Un propriétaire ou un administrateur crée les clés sous Paramètres, Clés API. Une clé commence par cmk_ et appartient à une seule organisation. Nous ne l’affichons qu’une fois et n’en conservons qu’une empreinte : copiez-la donc tout de suite. C’est aussi là que vous révoquez une clé ; les outils qui l’utilisent cessent alors immédiatement de fonctionner.

Envoyez la clé avec chaque requête :

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

Une clé peut effectuer 120 requêtes par minute. Au-delà, vous recevez le statut 429 ; attendez une minute et reprenez.

Lister vos sites

GET /api/v1/sites renvoie chaque site de l’organisation avec son ID, son domaine, sa clé de script, son statut et sa version en ligne.

GET /api/v1/sites/{id}/consents renvoie les choix, du plus récent au plus ancien. Il accepte les paramètres suivants :

ParamètreRôle
since, untilUniquement les choix de cette période, sous forme de dates ISO comme 2026-10-01.
limitLe nombre de choix, jusqu’à 1 000. La valeur par défaut est 100.
beforePour la page suivante : la valeur de next_before de la réponse précédente, telle quelle. Elle est vide sur la dernière page.

Chaque choix comporte l’ID de consentement, l’action, les trois catégories, le pays, la langue, la page, la version du bandeau et l’heure. Les adresses IP raccourcies et les détails du navigateur restent dans le tableau de bord.

GET /api/v1/consents/{consent_id} renvoie tous les choix faits avec un ID de consentement, sur n’importe quel site de l’organisation. Utilisez-le quand un visiteur vous communique l’ID affiché dans sa fenêtre des préférences et demande ce qu’il a accepté.

Voir la dernière analyse

GET /api/v1/sites/{id}/scan renvoie les constats, les contrôles, les cookies et les identifiants de suivi (comme les ID Tag Manager et de la balise Google) de la dernière analyse terminée.

Publier un site

POST /api/v1/sites/{id}/publish met en ligne le brouillon actuel, comme le bouton Publier. Vous pouvez envoyer une note, qui apparaît dans la liste des versions du site :

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 réponse contient le nouveau numéro de version.

Erreurs

Chaque erreur est renvoyée en JSON avec un champ error rédigé en anglais courant.

  • 400 : une date, un curseur ou un ID de consentement n’a pas le bon format.
  • 401 : la clé est absente, erronée ou révoquée.
  • 403 : l’organisation n’a pas accès à l’API, incluse à partir de dix sites payants.
  • 404 : le site n’appartient pas à cette organisation.
  • 409 : le site ne peut pas être publié, car il est archivé ou tous les sites payants sont déjà en ligne.
  • 429 : plus de 120 requêtes en une minute.
  • 500 : un problème est survenu de notre côté ; réessayez dans une minute.