REST API Introduction et connexion
Requête
Les requêtes doivent être envoyées en utilisant le protocole HTTPS. Toutes les URL commencent par l'adresse qui vous a été attribuée. Dans cette documentation, nous utiliserons l'adresse suivante :https://[YOUR_COMPANY].iquant.eu.
Veuillez contacter le support de Quant pour obtenir votre adresse URL.
Formats pris en charge
L'API prend actuellement en charge les formats JSON et SVG; selon le type de requête.
Si vous utilisez un autre format, le serveur répondra avec : HTTP 415 Unsupported Media Type.
Gestion des erreurs
Si l'API est temporairement indisponible, la réponse d'erreur sera de type 5XX. Il incombe au client de réessayer la requête dans ce cas.
Connexion
La connexion est requise pour communiquer avec l'API. En réponse à la connexion, vous recevrez un jeton (token) que vous utiliserez pour les requêtes suivantes. Le jeton sera valide pendant 30 minutes. Lorsqu'il expire, vous devrez vous reconnecter pour en obtenir un nouveau.
Vous devez vous connecter en utilisant un utilisateur Robot que vous créez dans Quant.
- Requête REST :
Paramètre | Valeur |
URL | /authenticate |
En-tête | Accept: application/json |
En-tête | Content-type: application/json |
Méthode | POST |
Corps (Payload) | {"username":"<username>","password":"<password>"} |
- Réponse REST :
Paramètre | Valeur |
Corps | {"token":"<token>","status":"<result>"} |
Si la connexion est réussie, vous recevrez la réponse suivante : HTTP 200. Et un jeton d'authentification dans la réponse. Sinon, l'attribut status dans la réponse contiendra un message d'erreur, par exemple :
HTTP 401 {"token":"","status":"Wrong username or password!"}"
Connexion à l'API REST
Requête
curl -H "accept: application/json" -H "content-type: application/json" "https://[YOUR_COMPANY].iquant.eu/authenticate" -d "{\"username\":\"xxxx\",\"password\":\"xxxx\"}"
Réponse
{"token":"nAti4s84yqxmgcOf16IOmp4NwLaJV7kJIoGFnzTDrra0JSEG02","status":"SUCCESS"}
Autorisation
L'autorisation s'effectue en ajoutant le jeton dans l'en-tête HTTP.
Paramètre | Valeur |
En-tête | Authorization: Bearer <TOKEN> |
Si le jeton est invalide, vous recevrez la réponse suivante :
HTTP 401 Unauthorized Content-Type: text/plain Body:"Token is missing or invalid!"
curl -H "accept:application/svg+xml" -H "Authorization: Bearer cDEHSUb03G8SJIAtHRYHYVeCmcxKxLDkVaUrhtBNGBSZpDyuBh" "https://[YOUR_COMPANY].iquant.eu/floorplan/55?productId=123456&kioskId=KID5&"
Paramétrage des tâches automatiques
Dans Quant, vous devez configurer des tâches automatiques spécifiques afin d'automatiser l'ensemble du processus de transfert de données.
Droits desktop
Cependant, vous devez d'abord configurer les droits desktop pour pouvoir visualiser et modifier les tâches automatiques.
Paramétrage des tâches automatiques
Dans la section Tâches automatiques, cliquez sur le bouton Nouveau pour ajouter une tâche automatique spécifique, que vous devrez ensuite configurer dans l'onglet Paramètres.
Paramètres des tâches par défaut
Certains paramètres sont communs à toutes les tâches. Il est donc recommandé de définir les propriétés récurrentes dans l'onglet Paramètres de tâche par défaut, afin de ne pas avoir à les configurer individuellement pour chaque tâche.
Dans les paramètres de tâche par défaut, nous recommandons de configurer les attributs dont les valeurs sont identiques pour tous les imports et exports, afin de ne pas avoir à les définir individuellement à chaque fois. Un exemple pourrait être les E-mails pour les notifications, où vous indiquez les adresses e-mail auxquelles les rapports de statuts d'erreur doivent être envoyés.
Chaque tâche automatique possède ses propres paramètres, qui sont toujours décrits dans le manuel correspondant à cette tâche automatique spécifique.