REST API Introducción e inicio de sesión
Solicitud
Las solicitudes deben enviarse utilizando HTTPS. Todas las URL comienzan con la dirección asignada. En esta documentación, indicaremos: https://[YOUR_COMPANY].iquant.eu.
Póngase en contacto con el soporte de Quant para obtener su dirección URL.
Formatos compatibles
Actualmente, la API soporta los formatos JSON y SVG en función del tipo de solicitud.
Si utiliza otro formato, recibirá una respuesta del servidor HTTP 415 Unsupported Media Type.
Tratamiento de errores
Si la API no está disponible temporalmente, la respuesta de error será 5XX. En este caso, es responsabilidad del cliente reintentar la solicitud.
Inicio de sesión
El inicio de sesión es necesario para comunicarse con la API. En respuesta al inicio de sesión, recibirá un token que utilizará para posteriores solicitudes. La ficha es válida durante 30 minutos. Si el token caduca, deberá volver a iniciar sesión para recibir uno nuevo.
Debe iniciar sesión utilizando el rol del usuario de Robot que se crea en Quant.
- REST Solicitud:
Parámetro | Valor |
URL | /authenticate |
Encabezado | Accept: application/json |
Encabezado | Content-type: application/json |
Método | POST |
Payload | {"username":"<username>","password":"<password>"} |
- REST Respuesta:
Parámetro | Valor |
Cuerpo | {"token":"<token>","status":"<result>"} |
Si el inicio de sesión se realiza correctamente, recibirá una respuesta: HTTP 200. Si el inicio de sesión se realiza correctamente, recibirá una respuesta. De lo contrario, el atributo de estado de la respuesta contendrá un mensaje de error, por ejemplo:
HTTP 401 {"token":"","status":"Wrong username or password!"}"
Inicio de sesión en REST API
Solicitud
curl -H "accept: application/json" -H "content-type: application/json" "https://[YOUR_COMPANY].iquant.eu/authenticate" -d "{\"username\":\"xxxx\",\"password\":\"xxxx\"}"
Respuesta
{"token":"nAti4s84yqxmgcOf16IOmp4NwLaJV7kJIoGFnzTDrra0JSEG02","status":"SUCCESS"}
Autorización
La autorización se realiza mediante un token adjunto a la cabecera HTTP.
Parámetro | Valor |
Encabezado | Authorization: Bearer <TOKEN> |
Si el token ya no es válido, recibirá una respuesta:
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&"
Configuración de tareas automáticas
En Quant, es necesario configurar tareas automáticas específicas para automatizar todo el proceso de transferencia de datos.
- Derechos de escritorio
Sin embargo, primero debes configurar los derechos de escritorio para poder ver y editar las tareas automáticas.Derechos de escritorio
- Configuración de tareas automáticas
En la sección Tarea automática, haz clic en el botón Nuevo para añadir una tarea automática específica, que luego deberás configurar en la pestaña Configuración.
Tareas automáticas
- Configuración predeterminada de tareas
Algunos ajustes se repiten en todas las tareas, por lo que es recomendable configurar todas las propiedades que se repiten en la pestaña Configuración predeterminada de tareas según tus necesidades, para no tener que modificarlas individualmente en cada tarea.
En la pestaña Configuración predeterminada de tareas, recomendamos configurar los atributos cuyos valores sean los mismos para todas las importaciones y exportaciones, de modo que no tengas que configurarlos individualmente cada vez. Un ejemplo podría ser Correos electrónicos para notificaciones, donde se especifican las direcciones de correo electrónico a las que deben enviarse los informes de estado de error.
Configuración predeterminada de tareas
Cada tarea automática tiene su propia configuración, que siempre se describirá en el manual correspondiente a esa tarea automática concreta.