Zum Hauptinhalt springen

API Zugriff / Sync

Automatische Synchronisierung zwischen Lizenzen und API - Zugriff​

Die Konfiguration einzelner WebCare - Lizenzen können automatisch synchronisiert oder per API abgefragt und geändert werden.

Dies ermöglicht sehr flexible Nutzungsszenarien:

  • Staging Lizenz: Sie können eine Lizenz für Ihre Testumgebung verwenden um neue Konfigurationen auszuprobieren bevor sie Live gehen sollen. Auf Knopfdruck können Sie dann die neuen Einstellungen in Ihre Produktivlizenz übernehmen.

  • Unternehmensweite CI und Privacy - Einstellungen: Wenn Sie mehrere Webauftritte verwalten, können Sie z.B. das Design des Banners oder die Formulierung der Datenschutzerklärung zentral vornehmen und diese dann automatisch in die Webauftritte übernehmen. Auf diese Weise wird jede Änderung in der zentralen Lizenz in beliebig viele Webauftritte übernommen.

  • Konfiguration ohne GUI: Wenn Ihre Webagentur gewisse Merkmale des Consent Banners schnell bearbeiten können soll (etwa die Farben oder Schriftarten), so können Sie eine JSON - formatierte Datei ablegen, die die Webagentur bearbeiten kann und die dann automatisch in die Lizenz eingespielt wird. Die Agentur benötigt dabei keinen Zugriff auf das WebCare - GUI.

screenshot

Format von API und JSON - Datei​

Hier finden Sie die Dokumentation zur Schnittstelle:

https://help.datareporter.eu/tools/api/webcare-conf/

Auch die Swagger (OpenAPI 3) Beschreibung können Sie herunterladen:

https://help.datareporter.eu/tools/api/webcare-conf/webcare_config.yaml

Import aus einer anderen Lizenz oder einer JSON Datei (URL)​

Um die Konfiguration aus einer anderen Lizenz zu importieren, muss die Quell - Lizenz über einen gültigen API - Schlüssel mit GET (Export) - Berechtigung verfügen.

hinweis

Die Ziel - Lizenz benötigt KEINEN API Key für den Import.

Server / API Key​

Hier tragen Sie die Informationen ein, die Sie in der Quelllizenz sehen, wenn Sie auf den API - Zugriffsschlüssel klicken.

Wenn Sie aus einer JSON Datei importieren wollen, benötigen Sie keinen API - Schlüssel.

Profil​

Hier können Sie einstellen, welche Konfigurationen Sie in die Ziellizenz übernehmen wollen. So können Sie beispielsweise nur die Banner - Farben übernehmen wenn Sie das wollen.

Modus​

Wenn Sie die Synchronisierung händisch durchführen wollen (beispielsweise bei einer Staging - Lizenz) wählen Sie hier "Manuell". Ansonsten können Sie die Frequenz einstellen, in der die Imports erfolgen sollen. Bitte beachten Sie dass eine hohe Frequenz (z.B. Stündlich) dazu führen kann, dass die Benutzer die in der Ziellizenz arbeiten auch öfter unterbrochen werden, da der Import naütrlich gewisse Felder überschreiben könnte die gerade bearbeitet werden.

Weiters führt eine hohe Frequenz auch zu sehr vielen Änderungen in den Historien von DSE und Impressum.

Letzter Import​

In diesem Bereich sehen Sie die Zeit des letzten Imports und den Status des Imports (Fehler, etc.).

Nächster Import (geplant)​

In diesem Feld wird angezeigt, wann der nächste Import erfolgt.

Jetzt importieren​

Der Import wird mit den aktuellen Einstellungen durchgeführt.

API Zugriffssschlüssel​

In diesem Bereich können Sie einen Zugriffsschlüssel für die API zum Zugriff auf die Konfiguration einrichten.

Es sind beliebig viele Zugriffssschlüssel möglich, eventuell ist es aus Sicherheitsgründen auch nötig, die Schlüssel durchzurotieren.

GET (Export)​

Mit dieser Berechtigung, dürfen Clients die Konfiguration der aktuellen Lizenz lesen.

POST (Import)​

Mit dieser Berechtigung, dürfen Clients die Konfiguration der aktuellen Lizenz schreiben.

Beispiel eines Zugriffs​

Die Konfiguration für den Zugriff haben wir mittels eines REST-Clients nachgebildet (in unserem Fall die App "PAW" unter macOS). Als URL - Parameter haben wir "?methods=" angehängt - damit werden alle Konfigurationen exportiert.

screenshot

Konfigurationsanleitung zu Nutzungsszenarien​

Wir haben hier ein paar der gebräuchlichsten Szenarien beschrieben und wie diese Konfiguriert werden können.

Staging Lizenz​

Sie besitzen zwei Lizenzen: eine Staging - Lizenz, die in Ihrem Testsystem eingebunden ist und eine Produktivlizenz die in der Live-Website eingebunden ist.

Staging Lizenz:

  • API Key mit GET - Berechtigung einrichten. Auf den Schlüssel klicken und die Zugangsdaten merken.

Produktiv Lizenz:

Unter "Konfiguration importieren von URL" folgende Einstellungen vornehmen:

  • Server/API Key: die gemerkten Einstellungen der Staging Lizenz einfügen
  • Profil: "Alles"
  • Modus: "Manuell"

Nun können Sie die Staging - Lizenz beliebig ändern und herumprobieren. Wenn die Tests abgeschlossen sind und Sie dei Einstellungen freischalten wollen, wechseln Sie in die Produktivlizenz und führen Sie unter "Konfiguration importieren von URL" die Funktion "Jetzt importieren" aus.

Unternehmensweite Datenschutzerklärung​

Sie besitzen eine Masterlizenz in der Sie die aktuelle, unternehmensweite Datenschutzerklärung als Vorlage verwalten. Die Websites sollen dieselbe Vorlage verwenden, aber nur die Datenschutzmodule enthalten die auf der jeweiligen Website auch verwendet werden.

Master Lizenz:

  • API Key mit GET - Berechtigung einrichten. Auf den Schlüssel klicken und die Zugangsdaten merken.

In jeder Website:

Unter "Konfiguration importieren von URL" folgende Einstellungen vornehmen:

  • Server/API Key: die gemerkten Einstellungen der Master Lizenz einfügen
  • Modus: "Täglich"
  • Profil: "Benutzerdefiniert" mit folgender Einstellung:

screenshot

Damit ist sichergestellt, dass alle Websites dieselbe Datenschutzerklärung verwenden. Die Module und Unternehmensdaten werden aber von der jeweiligen Website - Lizenz individuell eingefügt.

Daten der Organisation aus der Website selbst übernehmen​

Die Unternehmensdaten inklusive Geschäftsführung sollten zentral hinterlegt werden und automatisch in die Lizenz übernommen werden.

Website: In der Website wird eine Datei abgelegt, die z.B. unter https://www.datareporter.eu/config.json abgelegt wird.

In der Datei finden sich folgende Inhalte:

{
  "version" : 1,
  "consent" : null,
  "privacy" : null,
  "imprint" : null,
  "localization" : null,
  "publish" : null,
  "settings" : {
    "organization" : {
      "name" : "Niederlassung GmbH",
      "name2" : null,
      "street" : "Demostraße 1",
      "zip" : "4600",
      "city" : "Wels",
      "countryIso" : "at",
      "privacyOffice" : "",
      "companyNr" : "FN123456",
      "vatId" : "ATU123456789",
      "phone" : "0123 / 456789",
      "fax" : "0123/456789-11",
      "email" : "office@niederlassung.at",
      "emailPrivacy" : "privacy@webdemo.at"
    },
    "domains" : null,
    "roles" : [ {
      "roleCeo" : "",
      "rolePrivacyOfficer" : "",
      "rolePrivacyCoordinator" : "true",
      "gender" : "m",
      "title" : "Dr.",
      "firstName" : "Gustav",
      "lastName" : "Geschäftsführer",
      "email" : "emperor@webdemo.at"
    } ],
    "api" : null
  }
}

Lizenz:

screenshot