REST-API Einführung und Anmeldung
Anfrage
Anfragen müssen über HTTPS gesendet werden. Alle URLs beginnen mit der zugewiesenen Adresse. In dieser Dokumentation geben wir an:https://[IHR_UNTERNEHMEN].iquant.eu.
Bitte wenden Sie sich an den Quant-Support für Ihre URL-Adresse.
Unterstützte Formate
Die API unterstützt derzeit die Formate JSON und SVG, je nach Art der Anfrage.
Wenn Sie ein anderes Format verwenden, erhalten Sie eine Antwort vom Server HTTP 415 Unsupported Media Type.
Fehlerbehandlung
Wenn die API vorübergehend nicht verfügbar ist, lautet die Fehlerantwort 5XX. Es liegt in der Verantwortung des Kunden, die Anfrage in diesem Fall zu wiederholen.
Anmeldung
Die Anmeldung ist erforderlich, um mit der API zu kommunizieren. Als Antwort auf die Anmeldung erhalten Sie ein Token, den Sie für weitere Anfragen verwenden werden. Der Token ist 30 Minuten lang gültig. Wenn der Token abläuft, müssen Sie sich erneut anmelden, um einen neuen Token zu erhalten.
Sie müssen sich mit der Benutzerrolle Roboter anmelden, die Sie in Quant erstellen.
- REST-Anfrage:
Parameter | Wert |
URL | /authenticate |
Kopfzeile | Accept: application/json |
Kopfzeile | Inhaltstyp: application/json |
Methode | POST |
Payload | {"username":"<username>","password":"<password>"} |
- REST-Antwort:
Parameter | Wert |
Body | {"token":"<token>","status":"<result>"} |
Wenn die Anmeldung erfolgreich ist, erhalten Sie eine Antwort: HTTP 200. In der Antwort erhalten Sie ein Authentifizierungstoken. Andernfalls enthält das Status-Attribut in der Antwort eine Fehlermeldung, zum Beispiel:
HTTP 401 {"token":"","status":"Falscher Benutzername oder Passwort!"}"
Anmeldung bei REST API
Abfrage
curl -H "accept: application/json" -H "content-type: application/json" "https://[IHR_COMPANY]. iquant.eu/authenticate" -d "{\"username\":\"xxxx\",\"password\":\"xxxx\"}"
Antwort
{"token":"nAti4s84yqxmgcOf16IOmp4NwLaJV7kJIoGFnzTDrra0JSEG02","status":"SUCCESS"}
Autorisierung
Die Autorisierung wird mit einem Token durchgeführt, der an den HTTP-Header angehängt wird.
Parameter | Wert |
Kopfzeile | Berechtigung: Bearer <TOKEN> |
Wenn das Token bereits ungültig ist, erhalten Sie eine Antwort:
HTTP 401 Unauthorized Content-Type: text/plain Body:"Token fehlt oder ist ungültig!"
curl -H "accept:application/svg+xml" -H "Authorization: Bearer cDEHSUb03G8SJIAtHRYHYVeCmcxKxLDkVaUrhtBNGBSZpDyuBh" "https://[IHR_COMPANY].iquant.eu/floorplan/55?productId=123456&kioskId=KID5&"
Einrichtung automatischer Aufgaben
In Quant müssen Sie bestimmte automatische Aufgaben einrichten, um den gesamten Datenübertragungsprozess zu automatisieren.
- Desktop-Rechte
Zunächst müssen Sie jedoch Desktop-Rechte einrichten, um die automatischen Aufgaben anzeigen und bearbeiten zu können.
- Automatische Aufgaben
Klicken Sie im Abschnitt Automatische Aufgaben auf die Schaltfläche Neu, um eine bestimmte automatische Aufgabe hinzuzufügen, die Sie anschließend auf der Registerkarte Einstellungen einrichten müssen.
- Standardeinstellungen für Aufgaben
Da einige Einstellungen für alle Aufgaben gleich sind, empfiehlt es sich, alle wiederkehrenden Eigenschaften auf der Registerkarte Standardeinstellungen für Aufgaben nach Bedarf einzurichten, damit Sie diese nicht für jede Aufgabe einzeln ändern müssen.
In den Standardeinstellungen für Aufgaben empfehlen wir, Eigenschaften zu konfigurieren, deren Werte für alle Importe und Exporte gleich sind, damit Sie diese nicht jedes Mal einzeln einrichten müssen. Ein Beispiel hierfür sind die E-Mail-Adressen für Benachrichtigungen, unter denen Sie die E-Mail-Adressen angeben, an die Fehlerstatusberichte gesendet werden sollen.
Jede automatische Aufgabe verfügt über eigene Einstellungen, die stets in der Anleitung für die jeweilige automatische Aufgabe beschrieben sind.