Skip to main content

Retrieve configuration data via JSON

Question​

How can I get the configuration data as a JSON file for further processing in my own system?

Answer​

You can display a JSON download link in the internal e-mail. This allows your IT department to retrieve the configuration data directly.

Setup​

  1. Open your configurator in the Editor
  2. Click on Options (cogwheel symbol)
  3. Switch to Mail
  4. Open the cfg-internal section (internal mail template)
  5. Paste the following HTML code into the template:
<p>
  <a
    href="https://k3-api.objectcode.de/api/v1.0/cfg/{{cfg.code}}/shop"
    target="_blank"
    >JSON herunterladen</a
  >
</p>

After saving, a "Download JSON" link appears in every internal e-mail, which can be used to retrieve the configuration data.

→ Mehr zu Mail-Vorlagen

JSON format​

You can find the documentation for the JSON format here:

→ K3 Shop API – JSON-Dokumentation

Alternative: Webhook​

If you want to transfer the data automatically to your system (without manual download), you can set up a webhook. This automatically sends the configuration data to a URL of your choice.

→ Webhook einrichten

See also​