Si desea administrar su cuenta de Termly a través de la API o crear aplicaciones que se integren con Termly, por favor contáctenos para convertirse en socio agencia y hacer uso de nuestra API para socios.
La API de Consentimiento de Termly le permite obtener las categorías y las cookies a las que un usuario determinado ha dado su consentimiento.
Si está configurando cookies desde el backend, lea la guía sobre cómo bloquear cookies usando la API.
Autenticación
La autenticación a la API de Consentimiento de Termly se realiza mediante la clave API que se encuentra en su panel. La autenticación es única por sitio web en su cuenta.
GET cookie_whitelist
El endpoint cookie_whitelist devuelve las preferencias de consentimiento para un visitante dado. Esto incluye una lista de todas las cookies monitoreadas por Termly y la categoría de consentimiento a la que pertenecen.
https://app.termly.io/api/v1/cookie_whitelist
Ejemplo:
curl -H 'Accept: application/json' -H "Authorization: ${API_KEY}"
https://termly.io/api/v1/cookie_whitelist?uuid={UUID}Detalles de la solicitud
Encabezados
Encabezado |
Tipo |
Detalles |
Authorization (requerido) |
Cadena |
Encuentre su clave API en su panel de Termly |
Parámetros de consulta
Parámetro |
Tipo |
Detalles |
uuid (opcional) |
Cadena |
Identificador único para un visitante que tiene un registro de consentimiento. Puede obtener el UUID para un visitante en particular desde el frontend usando la devolución de llamada del SDK. Si no pasa el UUID, la API solo devolverá la lista de cookies clasificadas como Esenciales. |
Códigos de respuesta de la API
200 OK: API recuperada con éxito.
{ 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: Solicitud incorrecta
{ "error" : "Bad Request" }401: No autorizado
{ "error" : "Access denied!. Invalid token supplied." }o
{ "error" : "Access denied!. Deprecated token supplied." }Formatos de respuesta de la API
Formato de respuesta de lista de cookies
Respuesta |
Descripción |
Nombre |
Nombre de la cookie en la lista blanca |
Proveedor |
Dominio del proveedor.
Por ejemplo: un sitio web con "https://example.io" puede tener proveedor ".example.io" o "example.io" ("." delante de example.io significa que puede usar la cookie en un subdominio). Por lo tanto, debe tener en cuenta los dos proveedores posibles. |
Tipo |
Tipo de cookie.
Por ejemplo: tracker_type, html_local_storage, html_session_storage, server_cookie, pixel_tracker.
El backend puede necesitar bloquear solo "server_cookie". |
Formato de respuesta de lista de categorías
Respuesta |
Descripción |
Categorías |
Nombre de la categoría en la lista blanca |
Formato de respuesta del UUID
Respuesta |
Descripción |
uuid |
Identidad única del usuario del sujeto de datos (visitante) |