Si vous souhaitez gérer votre compte Termly via l’API ou créer des applications qui s’intègrent avec Termly, veuillez nous contacter pour devenir partenaire agence et utiliser notre API partenaire.
L’API de consentement de Termly vous permet de récupérer les catégories et les cookies auxquels un utilisateur donné a consenti.
Si vous configurez des cookies depuis le backend, consultez le guide sur comment bloquer les cookies en utilisant l’API.
Authentification
L’authentification à l’API de consentement Termly se fait via la clé API trouvée sur votre tableau de bord. L’authentification est unique pour chaque site web de votre compte.
GET cookie_whitelist
Le point de terminaison cookie_whitelist retourne les préférences de consentement pour un visiteur donné. Cela inclut une liste de tous les cookies surveillés par Termly et la catégorie de consentement à laquelle ils appartiennent.
https://app.termly.io/api/v1/cookie_whitelist
Exemple :
curl -H 'Accept: application/json' -H "Authorization: ${API_KEY}"
https://termly.io/api/v1/cookie_whitelist?uuid={UUID}Détails de la requête
En-têtes
En-tête |
Type |
Détails |
Authorization (obligatoire) |
Chaîne de caractères |
Trouvez votre clé API depuis votre tableau de bord Termly |
Paramètres de requête
Paramètre |
Type |
Détails |
uuid (optionnel) |
Chaîne de caractères |
Identifiant unique pour un visiteur qui possède un enregistrement de consentement. Vous pouvez obtenir le UUID d’un visiteur particulier depuis le frontend en utilisant le callback du SDK. Si vous ne transmettez pas le UUID, l’API ne retournera que la liste des cookies classés comme Essentiels. |
Codes de réponse de l’API
200 OK : API récupérée avec succès.
{ cookies: [ { 'name': 'cookie_name', 'provider': 'termly.io', 'type': 'http_cookie' }, { 'name': 'cookie_name', 'provider': 'termly.io', 'type': 'http_cookie' } ] categories: ['essential'], uuid: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'}400 : Mauvaise requête
{ "error" : "Bad Request" }401 : Non autorisé
{ "error" : "Access denied!. Invalid token supplied." }ou
{ "error" : "Access denied!. Deprecated token supplied." }Formats de réponse de l’API
Format de réponse liste des cookies
Réponse |
Description |
Nom |
Nom du cookie dans la liste blanche |
Fournisseur |
Domaine du fournisseur.
Par exemple : un site web avec « https://example.io » peut avoir pour fournisseur « .example.io » ou « example.io » (« . » devant example.io signifie que le cookie peut être utilisé dans un sous-domaine). Vous devez donc prendre en compte ces deux fournisseurs possibles. |
Type |
Type de cookie.
Par exemple : tracker_type, html_local_storage, html_session_storage, server_cookie, pixel_tracker.
Le backend peut simplement avoir besoin de bloquer « server_cookie. » |
Format de réponse liste des catégories
Réponse |
Description |
Catégories |
Nom de la catégorie dans la liste blanche |
Format de réponse du UUID
Réponse |
Description |
uuid |
Identité unique de l’utilisateur concerné (visiteur) |