Data Layer

Mit dem Data Layer erfährt Ihr Server während eines Besuchs, welches Unternehmen dahintersteht, zum Beispiel die Bergquell Mineralbrunnen GmbH. Am Ende haben Sie:

• einen Data-Layer-Schlüssel
• eine Anfrage, die zur IP-Adresse eines Besuchs ID und Namen des Unternehmens liefert, oder null, wenn Webmetic keines kennt

Für Matomo steht das fertige Matomo-Plugin bereit, das denselben Schlüssel nutzt.

Bevor Sie beginnenCopy Anchor Link

• Dauer: Schlüssel und erste Anfrage sind in wenigen Minuten eingerichtet.
• Konto: Sie brauchen ein Webmetic-Konto im Plan Enterprise.
• Zugang: Ihr Server muss https://hub.webmetic.de über das Internet erreichen.
• Rechte: Ein Admin erzeugt den Schlüssel. Andere Benutzer sehen das Fenster API-Schlüssel nicht und bitten einen Admin um den Schlüssel. Wenn ein Partner Ihr Konto betreut, entscheidet der Partner, ob API im Menü erscheint.
• Plan: Die serverseitige Erkennung gehört zum Plan Enterprise. Die Abfrage kostet derzeit keine Credits.

Schlüssel erstellenCopy Anchor Link

Sie brauchen den Schlüssel aus der Karte Data Layer, denn der Schlüssel aus der Karte Visitor Intelligence funktioniert hier nicht.

Umgekehrt gilt der Data-Layer-Schlüssel nicht an den Endpunkten der API.

1. Öffnen Sie Menü > Integrationen > API. Das Fenster API-Schlüssel öffnet sich.
2. Wenn die Karte Data Layer den Text Noch kein Schlüssel generiert. zeigt, klicken Sie auf Schlüssel generieren. Webmetic zeigt den neuen Schlüssel.
3. Klicken Sie in der Karte Data Layer auf das Symbol Kopieren. Webmetic kopiert den ganzen Schlüssel, auch wenn er verdeckt ist.

Ihr Konto hat genau einen Data-Layer-Schlüssel, der für alle Ihre Websites gilt und nicht abläuft.

Klicken Sie nicht auf Neu generieren, wenn Sie den Schlüssel schon nutzen. Nach dem zweiten Klick gilt der alte Schlüssel sofort nicht mehr, auch nicht im Matomo-Plugin. Das lässt sich nicht rückgängig machen.

Anfrage vom Server sendenCopy Anchor Link

Senden Sie für jeden Besuch, dessen Unternehmen Sie wissen möchten, eine Anfrage an GET https://hub.webmetic.de/dl mit zwei Headern:

• Authorization: Ihr Data-Layer-Schlüssel, unverändert und ohne Bearer davor.
• X-Data-Source: die öffentliche IP-Adresse des Besuchs.

curl "https://hub.webmetic.de/dl" \
  -H "Authorization: wmtc_IHR_API_SCHLUESSEL" \
  -H "X-Data-Source: 203.0.113.42"

JavaScript und Python brechen nach zwei Sekunden ab, damit Ihre Seite nicht auf die Antwort wartet. Sie wählen diesen Wert selbst.

Zum Testen brauchen Sie weder Enterprise noch ein Konto. Mit dem öffentlichen Demo-Schlüssel wmtc_demo und X-Data-Source: 203.0.113.42 antwortet /dl mit dem erfundenen Beispielunternehmen Bergquell Mineralbrunnen GmbH, bei jeder anderen Adresse mit null.

Wenn X-Data-Source fehlt, prüft Webmetic die Adresse, von der die Anfrage kommt, also die Ihres Servers und nicht die des Besuchs.

Webmetic vergleicht die Adresse Zeichen für Zeichen. Bei einer falsch übernommenen Adresse antwortet /dl deshalb nicht mit einem Fehler, sondern mit null. Achten Sie auf diese Punkte:

• Wenn ein Proxy, ein Content Delivery Network (CDN) oder ein Load Balancer vor Ihrem Server steht, sieht Ihr Server dessen Adresse. Nehmen Sie die Adresse des Besuchs dann aus dem Header, den er weitergibt, zum Beispiel X-Forwarded-For.
• Wenn dieser Header mehrere Adressen enthält, senden Sie nur die des Besuchs.
• Senden Sie IPv4-Adressen ohne das Präfix ::ffff:, das manche Server voranstellen.
• Senden Sie IPv6-Adressen in der üblichen Kurzschreibweise mit Kleinbuchstaben, wie die meisten Server sie liefern.

Jede Anfrage akzeptiert genau eine Adresse.

Antwort auswertenCopy Anchor Link

Wenn Webmetic ein Unternehmen zur Adresse kennt, antwortet /dl mit Status 200 und einem JSON-Objekt mit genau zwei Feldern:

{
  "cid": "41ea486a9c95",
  "cn": "Bergquell Mineralbrunnen GmbH"
}

• cid: die ID des Unternehmens in Webmetic. Wenn das Unternehmen Ihre Website besucht hat, finden Sie es in der API unter derselben company_id.
• cn: der Name des Unternehmens. Er ist null, wenn Webmetic zur ID keinen Namen kennt.

Wenn Webmetic kein Unternehmen kennt, ist der Body null, ebenfalls mit Status 200. Prüfen Sie im Code also den Body, nicht den Status.

/dl liefert keine Branche, Größe oder Domain.

/dl nennt jedes Unternehmen, das Webmetic zur Adresse kennt, auch wenn es Ihre Website noch nie besucht hat.

Eine Abfrage legt im Dashboard keinen Besuch und kein Unternehmen an. Die Domain-Blacklist gilt für den Data Layer nicht.

Antwort an den Tag Manager übergebenCopy Anchor Link

Wenn Ihre Tags in Google Tag Manager das Unternehmen brauchen, schreibt Ihr Server die Antwort beim Ausliefern der Seite in den window.dataLayer. Trotz des Namens schreibt Webmetic selbst nichts dort hinein.

Der Schlüssel bleibt dabei auf Ihrem Server, denn nur die Antwort gelangt in die Seite.

Webmetic gibt keine Ereignisse oder Variablen vor. Sie wählen die Namen selbst, zum Beispiel so:

<script>
  // Rendered into the page by your server. Event and field names are your choice.
  window.dataLayer = window.dataLayer || [];
  window.dataLayer.push({
    event: 'company_identified',
    company_id: '41ea486a9c95',
    company_name: 'Bergquell Mineralbrunnen GmbH',
  });
</script>

ReferenzCopy Anchor Link

Weil /dl nicht in der generierten API-Referenz steht, finden Sie alle Angaben zum Endpunkt hier.

AnfrageCopy Anchor Link

AntwortCopy Anchor Link

FehlerCopy Anchor Link

Fehler am Data Layer haben einen kürzeren Body als die Endpunkte der API. detail ist hier ein Text und kein Objekt mit error und message, zum Beispiel {"detail": "DATA_LAYER_KEY_MISSING"}. Prüfen Sie bei /dl deshalb detail als Zeichenkette.

Die Fehler der API stehen unter Fehler.

DatenschutzCopy Anchor Link

Auf welcher Rechtsgrundlage Sie die IP-Adressen Ihrer Besuche an Webmetic senden, klären Sie mit Ihrer Datenschutzberatung.

Nächste SchritteCopy Anchor Link