Se desideri gestire il tuo account Termly tramite API o creare app che si integrano con Termly, ti preghiamo di contattarci per diventare un partner agenzia e utilizzare la nostra Partner API.
La Consent API di Termly ti consente di recuperare le categorie e i cookie a cui un determinato utente ha dato il consenso.
Se stai impostando cookie dal backend, leggi la guida su come bloccare i cookie utilizzando l'API.
Autenticazione
L'autenticazione alla Termly Consent API avviene tramite la chiave API che trovi nella tua dashboard. L'autenticazione è unica per ogni sito web nel tuo account.
GET cookie_whitelist
L'endpoint cookie_whitelist restituisce le preferenze di consenso per un determinato visitatore. Questo include un elenco di tutti i cookie monitorati da Termly e la categoria di consenso a cui appartengono.
https://app.termly.io/api/v1/cookie_whitelist
Esempio:
curl -H 'Accept: application/json' -H "Authorization: ${API_KEY}"
https://termly.io/api/v1/cookie_whitelist?uuid={UUID}Dettagli della richiesta
Header
Header |
Tipo |
Dettagli |
Authorization (obbligatorio) |
Stringa |
Trova la tua chiave API nella tua dashboard Termly |
Parametri Query
Parametro |
Tipo |
Dettagli |
uuid (opzionale) |
Stringa |
Identificatore univoco per un visitatore che ha un record di consenso. Puoi ottenere l'UUID per un visitatore particolare dal frontend usando il callback SDK. Se non fornisci l'UUID, l'API restituirà solo l'elenco dei cookie classificati come Essenziali. |
Codici di risposta API
200 OK: API recuperata con successo.
{ 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: Bad Request
{ "error" : "Bad Request" }401: Unauthorized
{ "error" : "Accesso negato!. Token fornito non valido." }oppure
{ "error" : "Accesso negato!. Token fornito deprecato." }Formati di risposta API
Formato della risposta elenco dei cookie
Risposta |
Descrizione |
Name |
Nome del cookie in whitelist |
Provider |
Dominio del provider.
Per esempio: un sito web con "https://example.io" può avere come provider ".example.io" o "example.io" ("." davanti a example.io significa che puoi usare il cookie in un sottodominio). Quindi dovresti considerare i due possibili provider. |
Type |
Tipo di cookie.
Per esempio: tracker_type, html_local_storage, html_session_storage, server_cookie, pixel_tracker.
Il backend potrebbe dover bloccare solo i "server_cookie." |
Formato della risposta elenco delle categorie
Risposta |
Descrizione |
Categories |
Nome della categoria in whitelist |
Formato della risposta UUID
Risposta |
Descrizione |
uuid |
Identità unica dell'utente del soggetto dei dati (visitatore) |