Handbücher Datenintegration: REST API REST API Filiale Import V1

REST API Filiale Import V1

Diese Quelle wird verwendet, um den Datenimport in Quant zu speichern. Eingabe- und Ausgabeformat ist JSON.

Verwenden Sie die Ansicht  Automatische Aufgaben , um den Import zu erstellen und einzurichten. Sobald die Aufgabenliste erstellt ist, hat sie die ID, die Sie in der Anfrage-URL übergeben.

Automatische Aufgaben - Speicherdatenimport
  • Einstellungen

Bevor Sie die API verwenden, müssen Sie die folgenden Attribute auf der Registerkarte "Einstellungen" bearbeiten:

  • Kreuzen Sie das Attribut Aktiviert an, um die Aufgabe zu aktivieren.
  • Wählen Sie im Feld  Benutzer mit API-Zugriffsberechtigung einen oder mehrere Benutzer mit der Rolle "Roboter" aus, die zur Ausführung der Aufgabe berechtigt sind.
  • Wählen Sie unter Store Data Attribute Mapping die zu importierenden Attribute aus und ändern Sie optional deren JSON-Schlüssel.
  • Attribute
Attribut
Beschreibung
Typ
Aktiviert
Gibt an, ob die automatische Aufgabe aktiv ist und ob die Daten durch sie gesendet werden können.
ja/nein
Titel
Eigene Name der automatischen Aufgabe.
Text
Beschreibung
Benutzerdefinierte Beschreibung der Funktion der automatischen Aufgabe.
Formatierter Text
Hinweise
Notizen.
Langtext
E-Mails für Benachrichtigungen

Eine oder mehrere E-Mail-Adressen, an die E-Mails mit Fehlerbedingungen gesendet werden sollen.

Liste von Strings
Benutzer mit API-Zugangsberechtigung
Benutzer mit der Rolle Roboter, die berechtigt sind, die Aufgabe auszuführen.
Liste der Benutzer
Verzögerung in Sekunden vor erneutem Versuch
Die Anzahl der Sekunden, die der Client warten soll, bevor er den Import erneut versucht, falls die Warteschlange auf dem Server lang ist.


Store Data Attribute Mapping
Ein Mapping mit einem Eintrag für jedes zu importierende Attribut.

komplexer Typ

Maßeinheit
Maßeinheit wie cm, mm usw.
Auswahl
Datumsformat
Datumseingabeformat, z.B. 31.12.19
Auswahl
Datum und Zeitformat
Format für die Eingabe von Datum und Uhrzeit, z.B. 19.12.31 23:59:59
Auswahl
Listenelement-Trennzeichen
Zeichen zur Trennung der einzelnen Elemente bei Werten des Typs Liste
Auswahl

  • Anfrage

/v1/import/store-data/{task_id}

Parameter
Wert
URL
?debug, das der URL hinzugefügt wird, zeigt auch Warnungen in der Antwort an. Ohne diese Option werden nur Fehler angezeigt.
Kopfzeile
Accept: application/json
Kopfzeile
Inhaltstyp: application/json
Kopfzeile

Berechtigung: Bearer  <TOKEN>

TOKEN se získává pomocí /authenticate (siehe Login).

Methode
POST

Der Inhalt der Anfrage ist ein Array von JSON-Objekten, die die in der Store Data Attribute Mapping-Einstellung definierten Schlüssel enthalten.

  • Antwort
Schlüssel
Wert
Status
Eine Zeichenfolge, die den endgültigen Zustand des Imports beschreibt.
  • SUCCESS = fehlerfreier Importvorgang
  • PARTIAL_SUCCESS = Import abgeschlossen, aber eine oder mehrere Warnungen erzeugt
  • FAILURE = ein oder mehrere Fehler sind während des Imports aufgetreten
Warnungen
Es ist optional, d.h. es ist nur enthalten, wenn der Parameter ?debug in der URL enthalten ist und der Import mindestens eine Warnung erzeugt hat.
Liste der Warnzeichenfolgen.
Fehler
Optional - nur enthalten, wenn der Import mindestens einen Fehler erzeugt hat.
Liste der Warnzeichenfolgen.
Gesamtzeilen
Optional - wird nur eingefügt, wenn der Import nicht mit dem Status "FAILURE"
beendet wurde
Anzahl der eingegebenen Datensätze
Leere IDs
Anzahl der Datensätze mit leerem Store ID Wert.
Stores dupliziert
Optional - wird nur eingefügt, wenn der Import nicht mit dem Status "FAILURE"
beendet wurde
Anzahl der Datensätze, die übersprungen wurden, weil dieser Speicher bereits in einer anderen Anfrage importiert wurde.
  • Status Codes
Status
Wert
200 OK
Import erfolgreich mit dem Status "SUCCESS" oder "PARTIAL_SUCCESS". Die Antwort kann Warnungen oder kleinere Fehler enthalten.
400 Bad Request
Fehlerhafte Aufgabeneinstellungen oder falsche Anfrage.
401 Nicht autorisiert
Das Autorisierungs-Token ist ungültig, oder der Benutzer, der mit dem Token angemeldet ist, hat keine Berechtigung zur Ausführung dieser Aufgabe.
404 Nicht gefunden
Es wurde keine Aufgabe mit der in der URL angegebenen ID gefunden.
500 Internal Server Error

Ein kritischer serverseitiger Fehler ist während des Imports aufgetreten.

503 Dienst nicht verfügbar

Die Aufgabe wird bereits ausgeführt. Versuchen Sie, die Aufgabe nach der in der Antwortkopfzeile Retry-After angegebenen Anzahl von Sekunden erneut zu starten.

  • Ausführungsprotokoll

In Quant können Sie zusätzlich zu den Aufgabeneinstellungen auch Aufzeichnungen über einzelne Importe einsehen, einschließlich Statistiken, Fehler und Warnungen.

Execution Log

Wenn wir einen bestimmten Datensatz auswählen, können wir seine Details anzeigen, indem wir auf die Schaltfläche Elemente anzeigen klicken.

Elemente anzeigen 


  • Anfrage

curl -X POST --location "https://[IHR_COMPANY].iquant.eu/v1/import/store-data/159?debug" \

    -H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \

    -H "Accept: application/json" \

      -H "Content-Type: application/json" \

    -H "Cache-Control: no-cache" \

-d '[{ "Store ID": "100001", "Store Name": "Test Store" }]'

  • Antwort

{

  "Status": "SUCCESS", 

  "Total Lines": 1,

  "Leere IDs": 0,

  "Stores Duplicated": 0

}