Die allgemeine API ist so konzipiert, dass sie Dateneinträge im System abrufen, auflisten, aktualisieren, erstellen und löschen kann. Sie kann zur Automatisierung von Prozessen wie Lieferantenmanagement oder Designerstellung genutzt werden.

Modelle & Aktionen

Jeder Datentyp (z. B. ein CMP, ein Design, ein Anbieter usw.) wird als Modell bezeichnet; jedes Modell bietet mehrere Aktionen (get/list/update/…). Du kannst den Aufruf info verwenden, um die OpenAPI-Spezifikation aller Modelle und Aktionen abzurufen:

https://[API-Endpoint]/info

Bitte beachten Sie, dass nicht authentifizierte Aufrufe des Info-Modells zu einer OpenAPI-Spezifikation für nicht authentifizierte Aktionen führen. Um alle für Ihr Konto verfügbaren Modelle und Aktionen zu erhalten, authentifizieren Sie sich bitte zuerst.

URL-Struktur

Die Aufrufe zum Handeln folgen folgender Struktur:

https://[API-Endpoint]/model/[MODELNAME]/[ACTIONNAME]

Beispiel:

https://[API-Endpoint]/model/CMP/list

Neben Modellaufrufen gibt es Aufrufe zur Authentifizierung und zur OpenAPI-Spezifikation:

https://[API-Endpoint]/auth/[AUTH-ACTION]
https://[API-Endpoint]/info

Allgemeine Struktur der Botschaft

Die Kommunikation erfolgt durch den Austausch von JSON-Daten. Um eine Aktion zu starten, sende bitte eine POST-Anfrage mit den folgenden JSON-Daten im HTTP-Body:

{
  "accessType": 1,         // Access type (may be required for authentication calls)
  "lang":       1|2|3|..., // Language (optional)  
  "kmd":        "...",     // Authentication token (optional/required depending on context)  
  "key":        "..."      // Your API-Key (optional/required depending on context)
  // other fields might be required depending on context
}

Der Inhalt der JSON-Daten kann je nach auszuführender Aktion variieren. Bitte beachten Sie daher den Abschnitt „Aktionen“ hier.

Je nach Projektumsetzung ist für bestimmte Aktionen key für bestimmte Aktionen erforderlich sein (z. B. das Anlegen eines neuen Benutzers). Bitte wenden Sie sich an Ihren Kundenbetreuer, um Ihren Schlüssel zu erhalten.

Die API antwortet mit einem JSON-Body, der wie folgt formatiert ist:

{
  "status":     "...",  // Status: Success|Error 
  "statuscode": 0..999, // Status code
  "msg":        "...",  // Human readable status message
  "model":      "...",  // Context dependend. May return model type to be displayed or null
  "action":     "...",  // Action performed
  "data":        ...    // Type and content is depended on context  
}

Fehlercodes

Die API verwendet die folgenden Fehlercodes, um Probleme zu signalisieren. Der Fehlercode wird über die statuscode Eigenschaft der Antwort gesendet.

Zugriffstypen

Je nach API-Struktur gibt es verschiedene Zugriffstypen (JSON-Feld „accessType“). Bitte wenden Sie sich an Ihren Kundenbetreuer, um die ID für den Zugriffstyp zu erhalten, den Sie verwenden können.

Vorlagen

Je nach Projekt und Ihren Zugriffsrechten werden Ihnen möglicherweise unterschiedliche Vorlagen angezeigt (Datenstrukturen, die aus der Datenbank abgerufen bzw. in diese eingefügt werden sollen). Bitte klicken Sie hier rights auf, um eine Liste der Modelle und Aktionen zu erhalten.