Wenn Sie Ihr Termly-Konto über eine API verwalten oder Apps erstellen möchten, die sich in Termly integrieren lassen, kontaktieren Sie uns bitte über die Möglichkeit, Agenturpartner zu werden und unsere Partner-API zu nutzen.
Mit der Consent API von Termly können Sie die Kategorien und Cookies abrufen, denen ein bestimmter Nutzer zugestimmt hat.
Wenn Sie Cookies vom Backend aus setzen, lesen Sie die Anleitung zum Blockieren von Cookies über die API.
Authentifizierung
Die Authentifizierung bei der Termly Consent API erfolgt über den API-Schlüssel, den Sie in Ihrem Dashboard finden. Die Authentifizierung ist für jede Website in Ihrem Konto einzigartig.
Cookie_whitelist abrufen
Der Endpunkt cookie_whitelist gibt die Einwilligungseinstellungen für einen bestimmten Besucher zurück. Dazu gehört eine Liste aller von Termly überwachten Cookies und der Einwilligungskategorie, zu der sie gehören.
https://app.termly.io/api/v1/cookie_whitelist
Beispiel:
curl -H 'Accept: application/json' -H "Authorization: ${API_KEY}"
https://termly.io/api/v1/cookie_whitelist?uuid={UUID}Details zur Anfrage
Kopfzeilen
Kopfzeile | Typ | Details |
Berechtigung (erforderlich) | String | Finden Sie Ihren API-Schlüssel in Ihrem Termly Dashboard |
Abfrageparameter
Parameter | Typ | Details |
uuid (optional) | String | Einmaliger Identifikator für einen Besucher, der einen Zustimmungsdatensatz hat. Sie können die UUID für einen bestimmten Besucher vom Frontend über den SDK-Callback abrufen. Wenn Sie die UUID nicht übergeben, gibt die API nur die Liste der als wesentlich eingestuften Cookies zurück. |
API-Antwortcodes
200 OK: API erfolgreich abgerufen.
{ cookies: [ { 'name': 'cookie_name', 'provider': 'termly.io', 'type': 'http_cookie' }, { 'name': 'cookie_name', 'provider': 'termly.io', 'type': 'http_cookie' } ] Kategorien: ['essential'], uuid: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'}400: Fehlerhafte Anfrage
{"error" : "Schlechte Anfrage" }401: Nicht autorisiert
{ "error" : "Zugriff verweigert! Invalid token supplied." }oder
{ "error" : "Access denied!. Deprecated token supplied." }API-Antwortformate
Liste der Antwortformate von Cookies
Antwort | Beschreibung |
Name | Name des Whitelist-Cookies |
Provider | Anbieter-Domäne.
Zum Beispiel: Eine Website mit "https://example.io" kann den Provider ".example.io" oder "example.io" haben ("." vor example.io bedeutet, dass Sie das Cookie in einer Subdomain verwenden können). Sie sollten also die beiden möglichen Provider berücksichtigen. |
Typ | Typ des Cookies.
Zum Beispiel: tracker_type, html_local_storage, html_session_storage, server_cookie, pixel_tracker.
Es kann sein, dass das Backend nur "server_cookie" blockieren muss. |
Listenantwortformat der Kategorien
Antwort | Beschreibung |
Kategorien | Name der Kategorie auf der Whitelist |
Antwortformat der UUID
Antwort | Beschreibung |
uuid | Einzige Benutzerkennung der betroffenen Person (Besucher) |