Rest Api Benutzerdaten Import V1

Diese Quelle wird für den Import von Benutzern in Quant verwendet. Eingabe- und Ausgabeformat ist JSON.

Benutzen Sie den Abschnitt Automatische Aufgaben , um einen Import zu erstellen und einzurichten. Nach der Erstellung hat die Aufgabenliste die ID, die Sie in der Anfrage-URL angeben.

Aufgaben-ID

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 berechtigt sind, die Aufgabe auszuführen.
Im Bereich Benutzerdaten Attributzuordnung wählen Sie die zu importierenden Attribute aus und ändern optional deren JSON-Schlüssel
Um neue Benutzer zu erstellen oder die Rolle bestehender Benutzer zu ändern, müssen Sie die Rollen-Zuordnung für das Attribut Rolle vervollständigen. Hier geben Sie die Zeichenkette an, die als Wert des Attributs Role in JSON auftritt, und die Benutzerrolle in Quant, der sie zugewiesen ist.

Einstellungen

Attribute

duAttribut	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
Listenelement-Trennzeichen	Ein Zeichen, das Listenelemente trennt, z.B. für Werte des Attributs Einzelne Läden.	Auswahl aus vordefinierten Elementen
Nutzerdaten-Attribut-Zuordnung	Ein Mapping, das einen Eintrag für den Benutzernamen, die Rolle, die E-Mail und andere zu importierende Attribute enthält.	komplexer Typ

Role Mapping

Anfrage

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

Parameter	Wert
URL	?debug, das der URL hinzugefügt wird, zeigt auch eine Warnung in der Antwort an. Ohne diese Option werden nur Fehler angezeigt.
Kopfzeile	Accept: application/json
Kopfzeile	Inhaltstyp: application/json
Kopfzeile	Berechtigung: Bearer <TOKEN> TOKEN wird über /authenticate (siehe Einführung und Anmeldung Handbuch) bezogen.
Methode	POST

Der Inhalt der Anfrage ist ein Array von JSON-Objekten, die die in der Einstellung Zuordnung von Benutzerdatenattributen definierten Schlüssel enthalten. Jeder JSON-Datensatz beschreibt einen einzelnen Benutzer.

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 Fehlerzeichenfolgen.
Gesamtzeilen	Optional - wird nur eingefügt, wenn der Import nicht mit dem Status "FAILURE" beendet wurde Anzahl der eingegebenen Datensätze
Leere IDs	Optional - wird nur eingefügt, wenn der Import nicht mit dem Status "FAILURE" beendet wurde Anzahl der Datensätze mit einem leeren Benutzernamen.
Duplizierte Benutzer	Optional - Nur enthalten, wenn der Import nicht mit dem Status "FAILURE" beendet wurde Die Anzahl der Datensätze mit einem Benutzernamen, der zuvor in den Datensätzen auftauchte.
Nicht berücksichtigte Benutzer	Optional - wird nur eingefügt, wenn der Import nicht mit dem Status "FAILURE" beendet wurde Anzahl der ignorierten Datensätze aufgrund von: der Benutzername enthält unzulässige Zeichen der Benutzername ist bereits von einem anderen Kunden belegt der Benutzer existiert noch nicht und die Rolle ist nicht korrekt ausgefüllt Der Benutzer existiert noch nicht und die E-Mail ist leer oder hat ein falsches Format

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	Beim Export ist ein kritischer serverseitiger Fehler 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 "http://[IHR_COMPANY].iquant.eu/v1/import/user-data/206?debug" \

-H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \

-H "Accept: application/json" \

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

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

-d '[\

{ \

"Benutzername": "john.foo", \

"Name" : "John Foo", \

"Rolle": "catman", \

"E-Mail": "[email protected]", \

"Alle Läden": wahr \

}, \

{ \

"Benutzername": "jack.woo", \

"Name" : "Jack Woo", \

"Rolle": "Marktleiter", \

"E-Mail": "[email protected]", \

"Alle Läden": false \

Einzelne Filialen" "store1,store2,store3"

} \

Antwort

{

"Status": "SUCCESS",

"Gesamtzeilen": 2,

"Leere IDs": 0,

"Ignorierte Benutzer": 0,

"Doppelte Benutzer": 0

}