Dokumentation

Drei Wege, deine Bestellungen an Get5Stars zu senden: die Shopify-Integration mit einem Klick (empfohlen für Shopify-Händler), die REST-API (für jedes andere Backoffice) oder der einmalige CSV-Import aus deinem Dashboard.

• Shopify — Installation über das Dashboard und dann OAuth, kein Entwickler nötig. Siehe Shopify-Webhooks.
• REST-API — rufe bei jeder neuen Bestellung POST /api/v1/orders/ingest auf. Siehe REST-API.
• CSV-Import — lade eine CSV aus Meine Kunden hoch, um bis zu 10.000 Bestellungen auf einmal zu übertragen.

Basis-URL: https://get5stars.app. Alle Aufrufe werden über den Header x-api-key authentifiziert (dein Schlüssel ist unter Profil → API-Schlüssel sichtbar). Limit: 100 Anfragen / Minute / Schlüssel.

POST /api/v1/orders/ingest

Erstellt die Bestellung und plant die erste E-Mail + die zwei Erinnerungen gemäß deiner Kampagne. Idempotent über (merchantId, order_id).

curl -X POST https://get5stars.app/api/v1/orders/ingest \
  -H "x-api-key: $G5S_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "order_id": "ORD-2031",
    "customer_email": "alice@example.com",
    "customer_first_name": "Alice",
    "customer_last_name": "Dupont",
    "order_date": "2026-05-28T10:21:00Z",
    "customer_locale": "fr-FR"
  }'

Antworten

• 200 — { "order_id": "ORD-2031", "created": true }
• 200 — { "order_id": "ORD-2031", "created": false } (bereits erfasst, idempotent)
• 400 — ungültiges Payload (Zod). Der Body beschreibt das fehlerhafte Feld.
• 401 — API-Schlüssel fehlt oder Konto gesperrt.
• 402 — monatliches Kontingent erreicht (Starter 100 / Business 500). Bei Scale wird die Überschreitung mit +0,02 € berechnet.
• 429 — Rate-Limit überschritten (100/Min./Schlüssel).

Bewertungs-Endpunkte

Die Endpunkte /api/v1/reviews/rate und /api/v1/reviews/submit steuern den clientseitigen Bewertungsfluss. Normalerweise musst du sie nicht manuell aufrufen — sie werden von der öffentlichen Bewertungsseite verwendet, die Get5Stars bereitstellt.

Eine andere Plattform verbinden & testen

Für eine Nicht-Shopify-Plattform (WooCommerce, n8n, Zapier, eigener Code) sende deine Bestellungen mit deinem API-Schlüssel an POST /api/v1/orders/ingest. Bevor du einen Plan wählst, prüfe die Verbindung: sende eine Testanfrage an POST /api/v1/ping (Header x-api-key). Sobald sie eingeht, wird deine Plattform als verbunden markiert und du kannst dein Abonnement aktivieren.

Nach der OAuth-Installation über dein Dashboard registriert Get5Stars automatisch zwei Shopify-Webhooks: orders/create (löst die Bewertungssequenz aus) und app/uninstalled (DSGVO-Löschung). Du musst nichts manuell konfigurieren.

• orders/create — jede neue Shopify-Bestellung wird in eine Get5Stars-Bestellung umgewandelt. HMAC-Signatur mit deinem SHOPIFY_API_SECRET verifiziert.
• app/uninstalled — saubere Deinstallation: wir stoppen die E-Mails und starten die Datenlöschung innerhalb von 30 Tagen.
• shop/redact + customers/redact + customers/data_request — verpflichtende Shopify-DSGVO-Endpunkte. Implementiert und getestet.

Fehlerbehebung

• Eine Bestellung kommt nicht an? Prüfe Shopify Admin → Settings → Notifications → Webhooks. orders/create muss auf https://get5stars.app/api/webhooks/shopify zeigen.
• Du erhältst einen 401? Das HMAC-Secret hat sich geändert — installiere die App über dein Dashboard neu, um das Token zu erneuern.

Get5Stars nutzt ein Drittanbieter-LLM (OpenRouter) für zwei optionale Funktionen: die Themenextraktion aus negativen Bewertungen (Plan Business und höher) und das Verfassen von Antwortentwürfen (Plan Scale).

An das LLM gesendete Daten

• Themen: ausschließlich der Text von Bewertungen ≤ 3★, im gewählten Zeitfenster (7 Tage, 30 Tage oder gesamter Verlauf). Keine E-Mail, kein Name oder keine Kennung des Kunden und kein Shop-Name. Die Aufrufe sind inkrementell: Es werden nur neue Bewertungen gesendet, bereits berechnete Themen dienen als Kontext.
• KI-Antworten: ausschließlich der Bewertungstext, die Bewertung und der Vorname des Kunden (für die Anrede). Niemals der Name deines Shops oder Daten anderer Bewertungen.

Anbieter

• OpenRouter (Multi-Modell-Router, San Francisco, USA). Primäres Modell: Llama 3.3 70B (Meta, kostenlos, keine Datenspeicherung). Fallback: Gemini 2.5 Flash Lite (Google).
• Alle Aufrufe erfolgen Server-zu-Server von unseren Workern in der Region CDG (Vercel).

Aufbewahrung

• OpenRouter speichert bei den von uns verwendeten Modellen « free » und « no-retention » standardmäßig keine Prompts.
• Generierte KI-Entwürfe werden in deinem Dashboard (Feld aiReply) gespeichert, bis die Bewertung gelöscht wird.

Deaktivieren

Es wird keine Themenextraktion ausgeführt, solange du die Karte « Themen » im Dashboard nicht öffnest. KI-Antworten werden nur auf Anfrage generiert, über die Schaltfläche « KI-Antwort » in den Details einer Bewertung. Kontaktiere den Support, um LLMs in deinem Konto vollständig zu deaktivieren.