Domain API

Was ist eine Domain API?

Eine Domain API ist eine technische Schnittstelle, über die domainbezogene Daten automatisiert abgerufen oder in andere Systeme integriert werden können. API steht für „Application Programming Interface“, also Programmierschnittstelle. Sie ermöglicht es, dass Systeme miteinander kommunizieren, ohne dass Informationen manuell aus einer Benutzeroberfläche kopiert werden müssen.

Im Zusammenhang mit CCM19 bezeichnet die Domain API eine Schnittstelle, mit der Daten zu einzelnen Domains ausgelesen werden können. Dazu gehören insbesondere Consent- und Ereignisdaten, die pro Domain bereitgestellt und in andere Systeme integriert werden können.

Wofür wird die Domain API verwendet?

Eine Domain API wird verwendet, wenn domainbezogene Informationen nicht manuell über eine Benutzeroberfläche abgerufen, sondern automatisch verarbeitet werden sollen. Sie kann zum Beispiel genutzt werden, um Daten zu Domains, Statusinformationen, Statistiken oder Ereignissen in andere Systeme zu übertragen.

Das ist besonders hilfreich, wenn regelmäßig Informationen ausgewertet, dokumentiert oder in bestehende technische Prozesse eingebunden werden sollen. Über eine Domain API lassen sich wiederkehrende Abfragen automatisieren und Daten zentral weiterverarbeiten, etwa in eigenen Dashboards, internen Auswertungen, Monitoring-Systemen oder Schnittstellen zu anderen Anwendungen.

Domain API in CCM19

In CCM19 stellt die Domain API eine Schnittstelle bereit, mit der Daten pro Domain ausgelesen werden können. Die Dokumentation beschreibt unter anderem die Möglichkeit, alle Domains eines Accounts zu listen, Consent-Daten aus dem Protokoll abzurufen, einzelne Einträge über eine Consent-ID zu finden und Statistik-Daten einer Domain auszulesen.

Damit ist die Domain API besonders für technische Nutzer, Entwickler, Agenturen und Administratoren relevant. Sie kann eingesetzt werden, wenn Consent-Informationen, Ereignisdaten oder Statistikdaten nicht nur manuell im System geprüft, sondern automatisiert weiterverarbeitet werden sollen.

Unterschied zwischen Domain API und JavaScript-API

Die Domain API sollte nicht mit der JavaScript-API verwechselt werden. Beide Schnittstellen haben unterschiedliche Einsatzbereiche.

Die JavaScript-API wird im Frontend einer Website genutzt. Sie ermöglicht es, auf bestimmte Funktionen des Cookie-Managers zuzugreifen oder auf Nutzerinteraktionen zu reagieren. Dazu gehören zum Beispiel das Öffnen des Cookie-Dialogs, das Auslesen akzeptierter Einbindungen oder das Reagieren auf bestimmte JavaScript-Events.

Die Domain API arbeitet dagegen auf Ebene der domainbezogenen Datenabfrage. Sie dient nicht der direkten Bedienung des Cookie-Banners im Browser, sondern dem Abruf und der Integration von Daten aus CCM19 in andere Systeme.

API-Key und Zugriff

Für die Nutzung der Domain API wird ein API-Key benötigt. Dieser Schlüssel dient dazu, die API-Abfragen zu autorisieren und dem jeweiligen Account zuzuordnen.

In CCM19 kann der API-Key im entsprechenden Bereich ausgelesen oder neu gesetzt werden. Wird ein neuer API-Key erstellt, ist der bisherige Schlüssel nicht mehr gültig. Bestehende Abfragen oder Integrationen müssen dann entsprechend angepasst werden.

Der API-Key sollte vertraulich behandelt werden. Er sollte nicht öffentlich zugänglich sein und nur dort eingesetzt werden, wo er für die technische Anbindung tatsächlich benötigt wird.

Welche Daten können über die Domain API abgerufen werden?

Die verfügbaren Daten hängen vom jeweiligen Endpunkt ab. In CCM19 können über die Domain API unter anderem folgende Informationen abgefragt werden:

• alle Domains eines Accounts
• Consent-Daten aus dem aktuellen Protokoll
• einzelne Consent-Einträge über eine Consent-ID
• Consent-Historien zu einer bestimmten Consent-ID
• Statistik-Daten einer Domain
• Informationen wie Aufrufe des Skripts, Banner-Einblendungen, Zustimmungen, Ablehnungen oder Absprünge

Diese Daten können helfen, Consent-Prozesse besser auszuwerten, technische Abläufe zu prüfen oder Informationen in externe Systeme zu übernehmen.

Vorteile einer Domain API

Eine Domain API kann vor allem dann hilfreich sein, wenn mehrere Domains verwaltet oder Consent-Daten regelmäßig ausgewertet werden sollen. Sie reduziert manuelle Arbeit und ermöglicht eine strukturierte technische Weiterverarbeitung.

Zu den wichtigsten Vorteilen gehören:

• automatisierter Abruf domainbezogener Daten
• bessere Integration in bestehende Systeme
• Unterstützung eigener Auswertungen und Dashboards
• einfachere Verwaltung mehrerer Domains
• Zugriff auf Consent- und Ereignisdaten
• technische Grundlage für individuelle Workflows
• bessere Nachvollziehbarkeit von Einwilligungsdaten

Gerade für Agenturen, Unternehmen mit mehreren Websites oder technisch arbeitende Teams kann die Domain API eine nützliche Schnittstelle sein.

Einsatzbereiche der Domain API

Die Domain API wird vor allem in technischen und organisatorischen Prozessen eingesetzt, bei denen domainbezogene Daten aus CCM19 benötigt werden.

Typische Einsatzbereiche sind:

• Verwaltung mehrerer Domains
• Auswertung von Consent-Daten
• Abruf von Statistikdaten
• technische Dokumentation
• interne Dashboards
• Agentur- und Kundenprojekte
• Monitoring von Consent-Prozessen
• Integration in eigene Systeme oder Workflows

Eine Domain API ist damit keine Oberfläche für Endnutzer, sondern eine technische Schnittstelle für automatisierte Abfragen und Integrationen.