Anwendungsprogrammierschnittstelle für Partner (API)

Mittels API (Application Programming Interface) kannst du zusätzliche Sites anlegen.

Beispiel-Code dafür findest du hier!

How to: Login und Site anlegen


Damit das Site- & Login-Anlegen funktioniert, werden * curl und * jq vorausgesetzt.

# VARIABLEN

USERNAME=api-...
PASSWORD=password...

CLIENT_ID=clickskeks-public-ui

SSO_HOST=https://login.clickskeks.at
APP_HOST=https://app.clickskekssys.at
# GET ACCESS TOKEN / LOGIN

curl -v -X POST \
    -H "Content-Type: application/x-www-form-<wbr />urlencoded" \
    -d grant_type=password \
    -d scope="openid profile backend email" \
    -d client_id=${CLIENT_ID} \
    -d username=${USERNAME} \
    -d password=${PASSWORD} \
    -o result.tmp -w "@curl-format" \
    -b cookie.txt -c cookie.txt \
    ${SSO_HOST}/realms/master/<wbr />protocol/openid-connect/token

export ACCESS_TOKEN=$(cat result.tmp | jq -r .access_token)
rm -f result.tmp

# CREATE SITE

curl -v -X POST \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer ${ACCESS_TOKEN}" \
     -d @${COMMAND_FILE} \
     "${APP_HOST}/backend/v1/<wbr />partners/sites" \
	 -o result.tmp

cat result.tmp | jq .
rm -f result.tmp

How to: Site anlegen - COMMAND_FILE Datenformat

Mit dem folgenden Code kannst du durch minimal Imput - maximal Output erreichen. Konkret heißt das, dass hier nur wenige Daten notwendig sind und alles weitere mittels automatischer Generierung erzeugt wird. 

 

{
  "sitename": "example1.at",
  "gdprUrl": "https://example1.at/datenschutz",
  "legalNoticeUrl": "https://example1.at/impressum<wbr />",
  "contractorName": "Example1",
  "contractorUrl": "https://example1.at/about",
}

 

 

Außerdem können anschließend aufgelistete Felder optional gesandt werden:

 

{
    "sitename": "example1.at",
    "baseUrls": [
        "http://example1.at",
        "https://example1.at",
        "http://www.example1.at",
        "https://www.example1.at"
    ],
    "gdprUrl": "https://example1.at/datenschutz",
    "legalNoticeUrl": "https://example1.at/impressum<wbr />",
    "contractorName": "Example1",
    "contractorUrl": "https://example1.at/about",
    "design": {
        "blockingPerCookie" : false,
        "bannerLayoutClass" : "#123456",
		"denyAllButtonTextColor" : "#123456",
		"denyAllButtonBackgroundColor" : "#123456",
		"denyAllButtonBorderColor" : "#123456",
		"<wbr />acceptSelectedButtonTextColor" : "#123456",
		"<wbr />acceptSelectedButtonBackground<wbr />Color" : "#123456",
		"<wbr />acceptSelectedButtonBorderColo<wbr />r" : "#123456",
		"acceptAllButtonTextColor" : "#123456",
		"<wbr />acceptAllButtonBackgroundColor<wbr />" : "#123456",
		"acceptAllButtonBorderColor" : "#123456",
		"categoryToggleButtonColor" : "#123456",
		"<wbr />categoryToggleActiveBackground<wbr />Color" : "#123456",
		"<wbr />categoryToggleInactiveBackgrou<wbr />ndColor" : "#123456",
		"<wbr />cookieListActiveLabelTextColor<wbr />" : "#123456",
		"<wbr />cookieListActiveLabelBackgroun<wbr />dColor" : "#123456",
		"cookieIconColor" : "#123456",
		"cookieIconBackgroundColor" : "#123456"
    },
    "permissions": [ {"username": "a.munk(at)etennis.at"} ]
}

 

 

Das blockingPerCookie wird für die Aktivierungsoptionen genutzt. Hier kann entschieden werden, ob die Cookies entweder einzeln innerhalb des Banners aktivierbar sein sollen oder, ob der User nur ganze Kategorien de-/aktivieren kann.

 

bannerLayoutClass hat folgende mögliche Werte:

  • "" (leere Zeichenkette) - Standard-Layout (2-Buttons)

  • "clickskeks-popup-small" - Minimales Layout (2-Buttons)

  • "clickskeks-popup-new" - Standard Layout (3-Buttons)

  • "clickskeks-popup-new-small" - Minimales Layout (3-Buttons)

How to: Site anlegen - Return Values

Hier kannst du den Code für die Return Values entnehmen.

 

{
    "siteId": 912334,
	"siteUUID": "1234-5678-1234567890",
	"bannerUrl": "https://static.clickskeks.at/12/34/1234-5678-1234567890/bundle.js"
}