Konfiguration der Integrationsparameter

Damit die Konfiguration der Integration von family cherries möglichst selbsttätig erfolgen kann, werden die gewünschten Optionen im JSON-Format erfasst, und anschließend als Base64-encodiertes Argument an das family cherries Integrations-Script übergeben.

Hierzu kann folgende Konfigurations-JSON-Vorlage entsprechend adaptiert werden (Optionen für das Styling werden hier entsprechend den anderen Abschnitten eingefügt und sind weiter unten ersichtlich)

{
  "logoURL": "https:// URL zum gewünschten Bild Ihrer Seite",
  "imprintURL": "https:// URL zum Impressum Ihrer Seite",
  "privacyURL": "https:// URL zu den Datenschutzbestimmungen Ihrer Seite",
  "blogURL": "https:// URL zu Ihrer Seite",
  "blogName": "Name Ihrer Seite",
  "apiKey": "Der API-Key, den sie von blue cherries network erhalten haben"
}

Der blogName wird in der integrierten family cherries automatisch bei den Links zu Ihrem Impressum und den Datenschutzbestimmungen angezeigt.

Validierung der Konfiguration

Die gesamte Konfiguration (alles zwischen den geschwungenen Klammern { und } ) sollte anschließend auf eventuelle Formfehler überprüft werden. Dies ist ganz einfach möglich

Öffnen der JSONLint-Seite im Browser unter https://jsonlint.com
Einfügen der gesamten Konfiguraiton in das große Textfeld
Klick auf den Validate JSON Button am unteren Ende des Textfeldes.

Eventuelle Formfehler werden anschließend als Fehlermeldungen angezeigten und müssen korrigiert werden.

Minimieren der Konfiguration

Wenn die Prüfung auf Formfehler erfolgreich und fehlerfrei abgeschlossen wurde, wäre es als zweite optionalen Schritt gut, diese Konfiguriation zu minimieren, also alle unnötigen Zeichen zu entfernen. Dies ist ganz einfach möglich:

Öffnen der JSON Minifier Seite unter https://codebeautify.org/jsonminifier
Einfügen der zuvor geprüften Konfiguration in das Textfeld auf der linken Seite.
Im Textfeld auf der rechten Seite erscheint automatisch eine minimierte Darstellung der Konfiguration, die anschließend weiterverwendet werden sollte.

Encodieren der Konfiguration

Wenn die Prüfung auf Formfehler erfolgreich und fehlerfrei abgeschlossen und optional die Konfiguration auch noch minimiert wurde, muss diese noch in das kompaktere Base64 Format konvertiert werden. Dies ist ganz einfach möglich:

Öffnen der BASE64 Encode Seite unter https://www.base64encode.org
Einfügen der geprüften (und optional minimierten) Konfiguration in das Textfeld oben
Klick auf den Buttton ENCODE im oberen Abschnitt für Encode to Base64 format
Im Textfeld darunter erscheint anschließend ein unlesbarer, langer Text aus Groß- und Kleinbuchstaben, sowie Zahlen. Dieser muss nun kopiert werden und kann anschließend als Parameter als die Integration der family cherries übergeben werden.

Verwenden der Konfiguration

Die nun encodierte Konfiguration kann nun an den unter Installation eingerichteten Link auf family-cherries übergeben werden.

Hierzu muss der folgende Link adaptiert werden:

<script src="https://family-cherries.com/bcwhitelabel.js?configuration=" defer></script>

sodass nach dem = beim Parameter configuration der encodierte Text der Konfiguration angehängt wird. Es ist hierbei wichtig, dass wirklich der gesamte Text eingefügt wird!

Unter weiters muss auch noch der Abschnitt zwischen dem div-Element fc_configuration angepasst werden:

<div id="fc_configuration" style="display: none;";>
--> Hier muss die encodierte Konfiguration stehen
</div>

sodass die mit --> markierte Zeile durch die encodierte Konfiguration ersetzt wird.

Komplette Konfiguration mit Basis-Styling

{
  "logoURL": "https:// URL zum gewünschten Bild Ihrer Seite",
  "imprintURL": "https:// URL zum Impressum Ihrer Seite",
  "privacyURL": "https:// URL zu den Datenschutzbestimmungen Ihrer Seite",
  "blogURL": "https:// URL zu Ihrer Seite",
  "blogName": "Name Ihrer Seite",
  "apiKey": "Der API-Key, den sie von blue cherries network erhalten haben",  

  "cherriesLogoVariant": "entweder standard oder white",
  "primaryColor": "",
  "primaryLightColor": "",
  "primaryContrastColor": "",
  "navigationBarColor": "",
  "highlightColor": ""
}

Konfiguration