Einbetten mit der API
Das Snippet holt Etikett und Anzeige-Einstellungen aus der API. Die Seite braucht dafür keine strukturierten Daten.
Die API ist gebaut und getestet. Das Hosting unter api.garanify.com ist in Vorbereitung; bis dahin läuft sie lokal. Schlüssel gibt es auf Anfrage.
Produktseite
Eine Zeile, am besten vor </body>. Das Snippet fügt die Mitteilung und das Etikett nach dem Kaufen-Knopf ein.
<script src="https://cdn.garanify.com/garanify.min.js" defer
data-garanify-key="gfy_pk_4kq8Zt2mWc9x_…"
data-sku="WCR870"></script> Warenkorb und feste Plätze
Mit Platzhaltern bestimmen Sie den Ort selbst. data-display="nested" zeigt das kleine Etikett, das das große im Dialog öffnet.
<!-- einmal im Footer -->
<script src="https://cdn.garanify.com/garanify.min.js" defer
data-garanify-key="gfy_pk_4kq8Zt2mWc9x_…"></script>
<!-- je Warenkorbzeile -->
<div data-gfy="garan" data-sku="WCR870" data-display="nested"></div>
<div data-gfy="garan" data-sku="DF-2290"></div>
<!-- Mitteilung an fester Stelle -->
<div data-gfy="notice"></div> Attribute
| Attribut | Bedeutung |
|---|---|
data-garanify-key | Publishable Key. Schaltet den API-Modus ein; die Shop-ID steckt im Schlüssel. |
data-sku | SKU des Produkts dieser Seite. Macht die Seite zur Produktseite. |
data-lang | auto (Standard) oder ein Sprachcode wie fr. 24 EU-Amtssprachen. |
data-places | product, cart, checkout. Ohne Angabe gilt die Shop-Einstellung. |
data-max-width | Breite der Mitteilung in px. Ohne Angabe gilt die Shop-Einstellung. |
Verhalten
- Eine Anfrage je SKU und Seite, ohne Cookies, mit 3 Sekunden Timeout. Antworten werden 5 Minuten gecacht.
- Ist die API nicht erreichbar oder die SKU unbekannt, erscheint die Mitteilung trotzdem; nur das Etikett fehlt.
- Gründe stehen in
window.Garanify.config.api.errors.window.Garanify.rescan()prüft die Seite nach Änderungen erneut. - Die Seite muss auf einer Domain des Shops liegen. Für Staging-Domains die Domain am Shop ergänzen.
- Ohne
data-garanify-keyläuft das Snippet wie bisher offline mit Regeln im Code, siehe Plattformen.
Ohne JavaScript: HTML vom Server
Rendern Sie das Etikett auf Ihrem Server und geben Sie das HTML-Fragment mit Ihrer Seite aus. Dann ruft der Browser der Besucher die API nicht auf (siehe Datenschutz). Cachen Sie die Antwort mit dem ETag.
curl "https://api.garanify.com/v1/shops/shp_4kq8Zt2mWc9x/products/WCR870/garan?lang=de" \
-H "Authorization: Bearer $GARANIFY_SECRET_KEY"import { Garanify } from '@garanify/sdk';
const garanify = new Garanify({ apiKey: process.env.GARANIFY_SECRET_KEY });
const svg = await garanify.products.renderGaran('WCR870', {
lang: 'de'
});<?php
// composer require garanify/sdk guzzlehttp/guzzle
$factory = new GuzzleHttp\Psr7\HttpFactory();
$garanify = new Garanify\Garanify(getenv('GARANIFY_SECRET_KEY'), ['httpClient' => new GuzzleHttp\Client(), 'requestFactory' => $factory, 'streamFactory' => $factory]);
$svg = $garanify->products->renderGaran('WCR870', [
'lang' => 'de',
]);import os, requests
res = requests.get(
"https://api.garanify.com/v1/shops/shp_4kq8Zt2mWc9x/products/WCR870/garan?lang=de",
headers={"Authorization": f"Bearer {os.environ['GARANIFY_SECRET_KEY']}"},
timeout=10,
)
res.raise_for_status()Die Mitteilung: GET /v1/render/notice?lang=de&format=html, ohne Schlüssel.