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]/infoBitte 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/listNeben Modellaufrufen gibt es Aufrufe zur Authentifizierung und zur OpenAPI-Spezifikation:
https://[API-Endpoint]/auth/[AUTH-ACTION]
https://[API-Endpoint]/infoAllgemeine 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.
Wichtig: Bewahren Sie Ihren Schlüssel geheim und übertragen Sie ihn nicht über den Browser, sondern immer über eine Server-zu-Server-Verbindung!
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.
| Code | Beschreibung |
| 100–199 | Allgemeine Fehlercodes |
| 101 | Keine Eingabedaten gefunden |
| 102 | view/accessType fehlt oder ist falsch |
| 103 | Keine IDs übermittelt / IDs ungültig. Bitte senden Sie mindestens eine ID |
| 104 | Falscher Filter: Feld X existiert in Y nicht |
| 105 | Aktion fehlt oder ist falsch |
| 106 | Parameter X ist erforderlich/fehlt |
| 107 | Unbekannte oder leere Symbolleistenaktion |
| 108 | Aktion nicht zulässig |
| 109 | Aktion fehlgeschlagen |
| 110 | Die Aktion erlaubt höchstens eine ID oder gar keine. |
| 111 | Daten für ID x nicht gefunden. |
| 112 | Fehler beim Erstellen, siehe Fehlermeldung. Feldspezifische Meldungen siehe response.data |
| 113 | Aktualisierungsfehler, siehe Fehlermeldung. Feldspezifische Meldungen siehe response.data |
| 114 | Keine Daten zum Anlegen/Aktualisieren eines Elements |
| 115 | IDs müssen ein Array sein |
| 116 | Passwort kann nicht signiert werden |
| 117 | Maximale Anzahl an Artikeln überschritten |
| 200–299 | Anmelde-/Zugriffsfehler |
| 201 | Adserver deaktiviert |
| 202 | Benutzer nicht gefunden |
| 203 | IP auf der Sperrliste |
| 204 | Falsches Passwort |
| 205 | Anmeldedaten fehlen |
| 206 | Unbekannter Anmeldefehler |
| 207 | IP nicht auf der Whitelist |
| 208 | Passwortänderung erforderlich (Passwort zu alt) |
| 209 | Zugriff nicht erlaubt |
| 210 | Passwort-Aktualisierung nicht erfolgreich |
|
211 |
Token falsch |
| 212 | Token abgelaufen |
| 213 | Konto noch nicht aktiv |
| 214 | Unbekannter Zugriffstyp |
| 215 | Passwortänderung erforderlich |
| 216 | Deaktiviert |
| 217 | Unbekannter Fehler |
| 218 | Authentifizierungsschlüssel fehlt oder ist leer |
| 219 | Zwei-Faktor-Authentifizierung fehlt (Parameter senden 2fa) |
| 220 | Zwei-Faktor-Authentifizierung falsch |
| 221 | Zwei-Faktor: OTP-Code fehlt |
| 222 | Zwei-Faktor: OTP-Code falsch |
| 223 | Zwei-Faktor-Authentifizierung: E-Mail-Code fehlt |
| 224 | Zwei-Faktor-Authentifizierung: E-Mail-Code falsch |
| 225 | Zwei-Faktor-Authentifizierung: SMS-Code fehlt |
| 226 | Zwei-Faktor-Authentifizierung: SMS-Code falsch |
| 227 | Zwei-Faktor-Authentifizierung: E-Mail wird jetzt gesendet |
| 228 | Zwei-Faktor-Authentifizierung: SMS wird jetzt gesendet |
| 229 | E-Mail zur Passwortaktualisierung gesendet |
| 230 | Passwort aktualisiert |
| 300–399 | Interne Fehlercodes |
| 301 | Abhängigkeit für X auf Y konnte nicht aufgelöst werden |
| 302 | Die Abhängigkeit für X ergab eine leere Liste |
| 303 | Keine Spalte zum Aktualisieren |
| 304 | Abhängigkeitsfehler bei der Feldverwendung |
| 305 | Abhängigkeitsfehler bei leerem Feld |
| 306 | Listenabfrage ergab eine leere Feldliste |
| 307 | Authentifizierungs-Callback nicht gefunden |
| 308 | API-Include-Datei nicht gefunden: … |
| 399 | Allgemeiner interner Fehler |
| 900–999 | Benutzerdefinierte Fehlercodes, siehe Meldung |
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.