Zum Hauptinhalt springen

Konfigurationsdaten per JSON abrufen

Frage​

Wie kann ich die Konfigurationsdaten als JSON-Datei erhalten, um sie in meinem eigenen System weiterzuverarbeiten?

Antwort​

Sie können einen JSON-Download-Link in der internen E-Mail anzeigen lassen. So kann Ihre IT die Konfigurationsdaten direkt abrufen.

Einrichtung​

  1. Öffnen Sie Ihren Konfigurator im Editor
  2. Klicken Sie auf Optionen (Zahnrad-Symbol)
  3. Wechseln Sie zu Mail
  4. Öffnen Sie den Bereich cfg-internal (interne Mail-Vorlage)
  5. Fügen Sie folgenden HTML-Code in die Vorlage ein:
<p>
  <a
    href="https://k3-api.objectcode.de/api/v1.0/cfg/{{cfg.code}}/shop"
    target="_blank"
    >JSON herunterladen</a
  >
</p>

Nach dem Speichern erscheint in jeder internen E-Mail ein Link "JSON herunterladen", über den die Konfigurationsdaten abgerufen werden können.

→ Mehr zu Mail-Vorlagen

JSON-Format​

Die Dokumentation zum JSON-Format finden Sie hier:

→ K3 Shop API – JSON-Dokumentation

Alternative: Webhook​

Wenn Sie die Daten automatisch an Ihr System übertragen möchten (ohne manuellen Download), können Sie einen Webhook einrichten. Dabei werden die Konfigurationsdaten automatisch an eine URL Ihrer Wahl gesendet.

→ Webhook einrichten

Siehe auch​