API-Referenz
Alle Endpunkte der Version 1, erzeugt aus der OpenAPI-3.1-Datei. Basis-URL https://api.garanify.com.
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.
Shops
Ein Shop ist eine Website mit Domains, Sprachen und Anzeige-Einstellungen. Jeder Schlüssel gehört zu genau einem Shop.
| Methode | Pfad | Beschreibung | Schlüssel |
|---|---|---|---|
GET | /v1/me | Schlüssel prüfen | Secret Key, Publishable Key |
POST | /v1/shops | Weiteren Shop anlegen | Secret Key |
GET | /v1/shops/{shop} | Shop abrufen | Secret Key |
PATCH | /v1/shops/{shop} | Shop ändern | Secret Key |
GET | /v1/shops/{shop}/license | Tarif abrufen | Secret Key |
PUT | /v1/shops/{shop}/license | Lizenz verknüpfen | Secret Key |
DELETE | /v1/shops/{shop}/license | Lizenz lösen | Secret Key |
GET | /v1/shops/{shop}/evidence | Export evidence (CSV) | Secret Key |
Schlüssel
Secret Keys (gfy_sk_…) für Ihren Server, Publishable Keys (gfy_pk_…) für den Browser.
| Methode | Pfad | Beschreibung | Schlüssel |
|---|---|---|---|
GET | /v1/shops/{shop}/keys | Schlüssel auflisten | Secret Key |
POST | /v1/shops/{shop}/keys | Schlüssel anlegen | Secret Key |
POST | /v1/shops/{shop}/keys/{key}/rotate | Schlüssel rotieren | Secret Key |
DELETE | /v1/shops/{shop}/keys/{key} | Schlüssel sperren | Secret Key |
Produkte
Produkte mit Marke, Modellkennung und Herstellergarantie. Garanify speichert keine Endkundendaten.
| Methode | Pfad | Beschreibung | Schlüssel |
|---|---|---|---|
GET | /v1/shops/{shop}/products | Produkte auflisten | Secret Key |
POST | /v1/shops/{shop}/products/bulk | Bis zu 1000 Produkte speichern | Secret Key |
GET | /v1/shops/{shop}/products/{sku} | Produkt abrufen | Secret Key |
PUT | /v1/shops/{shop}/products/{sku} | Produkt anlegen oder ersetzen | Secret Key |
DELETE | /v1/shops/{shop}/products/{sku} | Produkt löschen | Secret Key |
Regeln
GARAN-Regeln geben allen passenden Produkten eine Herstellergarantie in Jahren. Pro und Agentur.
| Methode | Pfad | Beschreibung | Schlüssel |
|---|---|---|---|
GET | /v1/shops/{shop}/rules | Regeln auflisten | Secret Key |
PUT | /v1/shops/{shop}/rules | Alle Regeln ersetzen | Secret Key |
Auflösung
Welches Etikett für ein Produkt gilt und warum.
| Methode | Pfad | Beschreibung | Schlüssel |
|---|---|---|---|
GET | /v1/shops/{shop}/products/{sku}/resolve | Gespeichertes Produkt auflösen | Secret Key |
POST | /v1/shops/{shop}/resolve | Auflösen ohne Speichern | Secret Key |
Darstellung
Die offizielle Mitteilung und das GARAN-Etikett als SVG, PNG oder HTML-Fragment.
| Methode | Pfad | Beschreibung | Schlüssel |
|---|---|---|---|
GET | /v1/shops/{shop}/products/{sku}/garan | Etikett eines Produkts darstellen | Secret Key, Publishable Key |
GET | /v1/render/garan | GARAN-Etikett aus Werten darstellen | keiner |
GET | /v1/render/notice | Mitteilung darstellen | keiner |
GET | /v1/assets/fonts/{file} | Schriftdatei für HTML-Fragmente | keiner |
Öffentlich
Nur lesende Endpunkte für den Browser (Snippet), mit Publishable Key.
| Methode | Pfad | Beschreibung | Schlüssel |
|---|---|---|---|
GET | /v1/public/{shop} | Anzeige-Einstellungen eines Shops | Publishable Key |
GET | /v1/public/{shop}/products/{sku} | Etikett eines Produkts für den Browser | Publishable Key |
Webhooks
Signierte Benachrichtigungen über ungültige Produkte und Lizenzänderungen.
| Methode | Pfad | Beschreibung | Schlüssel |
|---|---|---|---|
GET | /v1/shops/{shop}/webhook | Webhook-Endpunkt abrufen | Secret Key |
PUT | /v1/shops/{shop}/webhook | Webhook-Endpunkt setzen | Secret Key |
DELETE | /v1/shops/{shop}/webhook | Webhook-Endpunkt löschen | Secret Key |
POST | /v1/shops/{shop}/webhook/test | Test-Ereignis senden | Secret Key |
GET | /v1/shops/{shop}/webhook/deliveries | Zustellungen auflisten | Secret Key |
POST | /v1/shops/{shop}/webhook/deliveries/{delivery}/retry | Zustellung erneut senden | Secret Key |
GET | /v1/webhook-events | Ereignistypen auflisten | keiner |
Meta
Sprachen, Module und Statusprüfung.
| Methode | Pfad | Beschreibung | Schlüssel |
|---|---|---|---|
GET | /health | Statusprüfung | keiner |
GET | /v1/languages | Sprachen auflisten | keiner |
GET | /v1/modules | Module auflisten | keiner |