Visión general
MyScanner es un portal de atención al cliente basado en la nube que se creó con el objetivo de permitir a los clientes acceder a sus datos de escaneado y a sus escáneres de forma segura y en tiempo real, desde cualquier lugar y en cualquier momento. La API de MyScanner pertenece a la categoría de Transferencia de Estado Representacional (REST). Te permite realizar operaciones «RESTful», como leer datos de escaneado de tu escáner de forma segura.
Para obtener la guía completa de la API de MyScanner, descárgala a continuación.
Operación
La API de MyScanner utiliza JSON plano a través de HTTP1 y utiliza los siguientes verbos HTTP:
Comando | Propósito |
---|---|
GET | Obtener uno o más objetos |
Nota:
- Todas las peticiones a la API deben llegar al punto final seguro, es decir, sólo HTTPS
- La API no permite la creación (POST), modificación (PUT) o eliminación (DELETE) de datos de escaneado en este momento
Límite de tarifa
Actualmente, el número de llamadas a la API por hora es ilimitado. LoadScan se reserva el derecho a modificarlo en cualquier momento sin previo aviso.
Políticas
Las API pueden ser eliminadas o modificadas en cualquier momento sin previo aviso, pero nos esforzaremos por conservar la funcionalidad existente siempre que sea posible.
Romper la política de cambios
Los cambios que no rompen una API, como añadir un nuevo atributo, pueden hacerse en cualquier momento. Los cambios que rompen una API a nivel de producción, como eliminar atributos o hacer cambios importantes en el comportamiento de la API, sólo se harán con un preaviso de 60 días. Sin embargo, puede haber raras ocasiones en las que, por motivos legales, de rendimiento o de seguridad, nos veamos obligados a realizar cambios de última hora sin previo aviso.
Autenticación
La autenticación de la API de MyScanner está restringida según la cuenta de usuario y el escáner mediante el uso de tokens de API. Los tokens API están vinculados a tu cuenta de usuario de MyScanner y a la lista de escáneres a los que tienes acceso. Los tokens de la API son cadenas de 64 bytes (64 caracteres de longitud) y hacen uso del código de autenticación de mensajes HMAC (keyed-hash message authentication code) utilizando el algoritmo hash seguro SHA-256, una función unidireccional que no puede descifrarse ni invertirse. La conexión a la API de MyScanner se realiza mediante HTTPS. Puedes utilizar tu token de API para autenticar la solicitud y no se requiere contraseña. Por ejemplo, si tu token de API es: 5ayHUgjsa952dY37PsSkydM023OiDbgsGuS2KEydBFY9i1xJOoLeHUnuOb0Bs9dQ
Y el número de serie1 de tu escáner es: 111111
Entonces una URL de ejemplo es:
https://myscannerapi.loadscan.com/api.php?sid=111111&token=5ayHUgjsa952dY37PsSkydM023OiDbgsGuS2KEydBFY9i1xJOoLeHUnuOb0Bs9dQ
Nota:
- Si no estás seguro del número de serie de tu escáner LVS, consulta la LVS Documentación del usuario
Obtener una clave API
- Iniciar sesión en MyScanner
- Haz clic en el nombre de tu cuenta en la esquina superior derecha.
- Cuando aparezca el menú desplegable, haz clic en «Perfil».
- Haz clic en la pestaña «Token API».
- Haz clic en «Generar token API».
- Cuando aparezca el cuadro de diálogo de confirmación, vuelve a hacer clic en «Generar token de API».
- Se generará tu token de API.
Qué proporciona la API
Se puede recuperar toda la información relativa al escáner que introduzcas en tu llamada a la API. Esto significa que se pueden recuperar todos los registros de escaneado que haya grabado MyScanner.
Derechos de acceso
Tu capacidad para acceder a los datos depende de los permisos disponibles para tu usuario de MyScanner.
Esquema
Campos en blanco:
Los campos en blanco se incluyen como nulos o «» en lugar de omitirse.
Campos DateTime:
Todas las marcas de tiempo se devuelven en formato ISO 8601 AAAA-MM-DD HH:MM:SS (Ejemplo : 2016-12-25 13:30:00)
Solicita
Todas las solicitudes requieren un mínimo de dos parámetros GET.
- El número de serie1 del escáner del que deseas recuperar datos
- Tu token de la API de MyScanner2
Nota:
- Si no estás seguro del número de serie de tu escáner LVS, consulta la LVS Documentación del usuario
- Consulta la documentación anterior con respecto a la generación del token de la API de MyScanner
Obtén TODO
OBTENER | todos los registros | |||
---|---|---|---|---|
Caso práctico | Deseas devolver todos los datos de escaneado de un escáner. | |||
Parámetros | NOMBRE | TIPO | FORMATO | EJEMPLO |
sid | cadena(6) | XXXXXX | 111111 |
URL de la solicitud:
https://myscannerapi.loadscan.com/api.php?sid=111111&token=5ayHUgjsa952dY37PsSkydM023OiDbgsGuS2KEydBFY9i1xJOoLeHUnuOb0Bs9dQ
Es posible que el último registro devuelto se refiera a una exploración que aún no haya finalizado y que el operador del escáner la haya cancelado a posteriori. Actualmente, si necesitas conocer con precisión el estado de cada registro a través de la API, tendrás que volver a comprobar ese último registro más adelante para ver si se canceló después de que se recuperara originalmente, y se han procesado otras exploraciones. Consulta las peticiones «Cancelado» y «Simple» más abajo para ver cómo solucionar esto.
Muestra de respuesta
[ { «Registro»: «111111-000000», «Hora»: «2015-07-25 00:00:00», «Dir.»: «OUT», «Operador»: «BIG MINE CO», «ID Camión»: «TRK0001», «Carga del camión (m3)»: «23,5», «ID de remolque»: «», «Carga del remolque (m3)»: «», «Total (m3)»: «23,5», «Estado»: «», «Conductor del camión»: «Adrian Ruthe», «Bogger ID»: «B123», «Operador del Bogger»: «John Key», «Fuente de carga»: «X1FE2», «Lugar de carga»: «X2FE1», «Destino de carga»: «ROM Principal», «Emplazamiento»: «GRAN MINA KAHUNA», «Cancelado»: false }, … ]
Registro MAYOR QUE
OBTENER | todos los registros | > | últimoregistro | |
---|---|---|---|---|
Caso práctico | Deseas devolver todos los datos de escaneado de un escáner posteriores al último número de registro que hayas almacenado: 111111-000017 | |||
Parámetros | NOMBRE | TIPO | FORMATO | EJEMPLO |
sid | cadena(6) | XXXXXX | 111111 | |
últimoregistro | cadena(13 | XXXXXX-XXXXXX | 111111-000017 |
URL de la solicitud: https://myscannerapi.loadscan.com/api.php?sid=111111&lastrecord=111111-000017&token=5ayHUgjsa952dY37PsSkydM023OiDbgsGuS2KEydBFY9i1xJOoLeHUnuOb0Bs9dQ
Es posible que el último registro devuelto se refiera a una exploración que aún no haya finalizado y que el operador del escáner la haya cancelado a posteriori. Actualmente, si necesitas conocer con precisión el estado de cada registro a través de la API, tendrás que volver a comprobar ese último registro más adelante para ver si se canceló después de que se recuperara originalmente, y se han procesado otras exploraciones. Consulta las peticiones «Cancelado» y «Simple» más abajo para ver cómo solucionar esto.
Muestra de respuesta
[
{
«Record»: «111111-000018»,
«Time»: «2015-07-25 00:50:00»,
«Dir.»: «OUT»,
«Operator»: «BIG MINE CO»,
«Truck ID»: «TRK0001»,
«Truck Load (m3)»: «23.5»,
«Trailer ID»: «»,
«Trailer Load (m3)»: «»,
«Total (m3)»: «23.5»,
«Status»: «»,
«Truck Driver»: «Adrian Ruthe»,
«Bogger ID»: «B123»,
«Bogger Operator»: «John Key»,
«Load Source»: «X1FE2»,
«Loading Location»: «X2FE1»,
«Load Destination»: «Main ROM»,
«Site»: «BIG KAHUNA MINE»,
«Cancelled»: false
}, {
«Record»: «111111-000019»,
«Time»: «2015-07-25 00:53:00»,
«Dir.»: «OUT»,
«Operator»: «BIG MINE CO»,
«Truck ID»: «TRK0001»,
«Truck Load (m3)»: «23.5»,
«Trailer ID»: «»,
«Trailer Load (m3)»: «»,
«Total (m3)»: «23.5»,
«Status»: «»,
«Truck Driver»: «Adrian Ruthe»,
«Bogger ID»: «B123»,
«Bogger Operator»: «John Key»,
«Load Source»: «X1FE2»,
«Loading Location»: «X2FE1»,
«Load Destination»: «Main ROM»,
«Site»: «BIG KAHUNA MINE»,
«Cancelled»: false
}
]
FechaHora DESPUÉS
OBTENER | todos los registros | |||
DESPUÉS DE | ||||
Casos prácticos | Deseas obtener todos los datos de escaneado de todos los registros posteriores a la fecha (25 ago 2015) y hora (12:48 h) | |||
Parámetros | NOMBRE | TIPO | FORMATO | EJEMPLO |
sid | cadena(6) | XXXXXX | 111111 | |
después de | cadena(19) | AAAA-MM-DD+HH:MM:SS | 2015-07-25+00:48:00 |
Notas:
‘+’ separa FECHA+TIEMPO sólo a efectos de codificación de URL.
La API leerá espacios en blanco, «%20» o «+».
URL de la solicitud: https://myscannerapi.loadscan.com/api.php?sid=111111&after=2015-07-25+00:48:00&token=5ayHUgjsa952dY37PsSkydM023OiDbgsGuS2KEydBFY9i1xJOoLeHUnuOb0Bs9dQ
Es posible que el último registro devuelto se refiera a una exploración que aún no haya finalizado y que el operador del escáner la haya cancelado a posteriori. Actualmente, si necesitas conocer con precisión el estado de cada registro a través de la API, tendrás que volver a comprobar ese último registro más adelante para ver si se canceló después de que se recuperara originalmente, y se han procesado otras exploraciones. Consulta las peticiones «Cancelado» y «Simple» más abajo para ver cómo solucionar esto.
Muestra de respuesta
[
{
«Record»: «111111-000018»,
«Time»: «2015-07-25 00:50:00»,
«Dir.»: «OUT»,
«Operator»: «BIG MINE CO»,
«Truck ID»: «TRK0001»,
«Truck Load (m3)»: «23.5»,
«Trailer ID»: «»,
«Trailer Load (m3)»: «»,
«Total (m3)»: «23.5»,
«Status»: «»,
«Truck Driver»: «Adrian Ruthe»,
«Bogger ID»: «B123»,
«Bogger Operator»: «John Key»,
«Load Source»: «X1FE2»,
«Loading Location»: «X2FE1»,
«Load Destination»: «Main ROM»,
«Site»: «BIG KAHUNA MINE»,
«Cancelled»: false
},
{
«Record»: «111111-000019»,
«Time»: «2015-07-25 00:53:00»,
«Dir.»: «OUT»,
«Operator»: «BIG MINE CO»,
«Truck ID»: «TRK0001»,
«Truck Load (m3)»: «23.5»,
«Trailer ID»: «»,
«Trailer Load (m3)»: «»,
«Total (m3)»: «23.5»,
«Status»: «»,
«Truck Driver»: «Adrian Ruthe»,
«Bogger ID»: «B123»,
«Bogger Operator»: «John Key»,
«Load Source»: «X1FE2»,
«Loading Location»: «X2FE1»,
«Load Destination»: «Main ROM»,
«Site»: «BIG KAHUNA MINE»,
«Cancelled»: false
}
]
En este artículo
Visión general
MyScanner es un portal de atención al cliente basado en la nube que se creó con el objetivo de permitir a los clientes acceder a sus datos de escaneado y a sus escáneres de forma segura y en tiempo real, desde cualquier lugar y en cualquier momento. La API de MyScanner pertenece a la categoría de Transferencia de Estado Representacional (REST). Te permite realizar operaciones «RESTful», como leer datos de escaneado de tu escáner de forma segura.
Para obtener la guía completa de la API de MyScanner, descárgala a continuación.
Operación
La API de MyScanner utiliza JSON plano a través de HTTP1 y utiliza los siguientes verbos HTTP:
Comando | Propósito |
---|---|
GET | Obtener uno o más objetos |
Nota:
- Todas las peticiones a la API deben llegar al punto final seguro, es decir, sólo HTTPS
- La API no permite la creación (POST), modificación (PUT) o eliminación (DELETE) de datos de escaneado en este momento
Límite de tarifa
Actualmente, el número de llamadas a la API por hora es ilimitado. LoadScan se reserva el derecho a modificarlo en cualquier momento sin previo aviso.
Políticas
Las API pueden ser eliminadas o modificadas en cualquier momento sin previo aviso, pero nos esforzaremos por conservar la funcionalidad existente siempre que sea posible.
Romper la política de cambios
Los cambios que no rompen una API, como añadir un nuevo atributo, pueden hacerse en cualquier momento. Los cambios que rompen una API a nivel de producción, como eliminar atributos o hacer cambios importantes en el comportamiento de la API, sólo se harán con un preaviso de 60 días. Sin embargo, puede haber raras ocasiones en las que, por motivos legales, de rendimiento o de seguridad, nos veamos obligados a realizar cambios de última hora sin previo aviso.
Autenticación
La autenticación de la API de MyScanner está restringida según la cuenta de usuario y el escáner mediante el uso de tokens de API. Los tokens API están vinculados a tu cuenta de usuario de MyScanner y a la lista de escáneres a los que tienes acceso. Los tokens de la API son cadenas de 64 bytes (64 caracteres de longitud) y hacen uso del código de autenticación de mensajes HMAC (keyed-hash message authentication code) utilizando el algoritmo hash seguro SHA-256, una función unidireccional que no puede descifrarse ni invertirse. La conexión a la API de MyScanner se realiza mediante HTTPS. Puedes utilizar tu token de API para autenticar la solicitud y no se requiere contraseña. Por ejemplo, si tu token de API es: 5ayHUgjsa952dY37PsSkydM023OiDbgsGuS2KEydBFY9i1xJOoLeHUnuOb0Bs9dQ
Y el número de serie1 de tu escáner es: 111111
Entonces una URL de ejemplo es:
https://myscannerapi.loadscan.com/api.php?sid=111111&token=5ayHUgjsa952dY37PsSkydM023OiDbgsGuS2KEydBFY9i1xJOoLeHUnuOb0Bs9dQ
Nota:
- Si no estás seguro del número de serie de tu escáner LVS, consulta la LVS Documentación del usuario
Obtener una clave API
- Iniciar sesión en MyScanner
- Haz clic en el nombre de tu cuenta en la esquina superior derecha.
- Cuando aparezca el menú desplegable, haz clic en «Perfil».
- Haz clic en la pestaña «Token API».
- Haz clic en «Generar token API».
- Cuando aparezca el cuadro de diálogo de confirmación, vuelve a hacer clic en «Generar token de API».
- Se generará tu token de API.
Qué proporciona la API
Se puede recuperar toda la información relativa al escáner que introduzcas en tu llamada a la API. Esto significa que se pueden recuperar todos los registros de escaneado que haya grabado MyScanner.
Derechos de acceso
Tu capacidad para acceder a los datos depende de los permisos disponibles para tu usuario de MyScanner.
Esquema
Campos en blanco:
Los campos en blanco se incluyen como nulos o «» en lugar de omitirse.
Campos DateTime:
Todas las marcas de tiempo se devuelven en formato ISO 8601 AAAA-MM-DD HH:MM:SS (Ejemplo : 2016-12-25 13:30:00)
Solicita
Todas las solicitudes requieren un mínimo de dos parámetros GET.
- El número de serie1 del escáner del que deseas recuperar datos
- Tu token de la API de MyScanner2
Nota:
- Si no estás seguro del número de serie de tu escáner LVS, consulta la LVS Documentación del usuario
- Consulta la documentación anterior con respecto a la generación del token de la API de MyScanner
Obtén TODO
OBTENER | todos los registros | |||
---|---|---|---|---|
Caso práctico | Deseas devolver todos los datos de escaneado de un escáner. | |||
Parámetros | NOMBRE | TIPO | FORMATO | EJEMPLO |
sid | cadena(6) | XXXXXX | 111111 |
URL de la solicitud:
https://myscannerapi.loadscan.com/api.php?sid=111111&token=5ayHUgjsa952dY37PsSkydM023OiDbgsGuS2KEydBFY9i1xJOoLeHUnuOb0Bs9dQ
Es posible que el último registro devuelto se refiera a una exploración que aún no haya finalizado y que el operador del escáner la haya cancelado a posteriori. Actualmente, si necesitas conocer con precisión el estado de cada registro a través de la API, tendrás que volver a comprobar ese último registro más adelante para ver si se canceló después de que se recuperara originalmente, y se han procesado otras exploraciones. Consulta las peticiones «Cancelado» y «Simple» más abajo para ver cómo solucionar esto.
Muestra de respuesta
[ { «Registro»: «111111-000000», «Hora»: «2015-07-25 00:00:00», «Dir.»: «OUT», «Operador»: «BIG MINE CO», «ID Camión»: «TRK0001», «Carga del camión (m3)»: «23,5», «ID de remolque»: «», «Carga del remolque (m3)»: «», «Total (m3)»: «23,5», «Estado»: «», «Conductor del camión»: «Adrian Ruthe», «Bogger ID»: «B123», «Operador del Bogger»: «John Key», «Fuente de carga»: «X1FE2», «Lugar de carga»: «X2FE1», «Destino de carga»: «ROM Principal», «Emplazamiento»: «GRAN MINA KAHUNA», «Cancelado»: false }, … ]
Registro MAYOR QUE
OBTENER | todos los registros | > | últimoregistro | |
---|---|---|---|---|
Caso práctico | Deseas devolver todos los datos de escaneado de un escáner posteriores al último número de registro que hayas almacenado: 111111-000017 | |||
Parámetros | NOMBRE | TIPO | FORMATO | EJEMPLO |
sid | cadena(6) | XXXXXX | 111111 | |
últimoregistro | cadena(13 | XXXXXX-XXXXXX | 111111-000017 |
URL de la solicitud: https://myscannerapi.loadscan.com/api.php?sid=111111&lastrecord=111111-000017&token=5ayHUgjsa952dY37PsSkydM023OiDbgsGuS2KEydBFY9i1xJOoLeHUnuOb0Bs9dQ
Es posible que el último registro devuelto se refiera a una exploración que aún no haya finalizado y que el operador del escáner la haya cancelado a posteriori. Actualmente, si necesitas conocer con precisión el estado de cada registro a través de la API, tendrás que volver a comprobar ese último registro más adelante para ver si se canceló después de que se recuperara originalmente, y se han procesado otras exploraciones. Consulta las peticiones «Cancelado» y «Simple» más abajo para ver cómo solucionar esto.
Muestra de respuesta
[
{
«Record»: «111111-000018»,
«Time»: «2015-07-25 00:50:00»,
«Dir.»: «OUT»,
«Operator»: «BIG MINE CO»,
«Truck ID»: «TRK0001»,
«Truck Load (m3)»: «23.5»,
«Trailer ID»: «»,
«Trailer Load (m3)»: «»,
«Total (m3)»: «23.5»,
«Status»: «»,
«Truck Driver»: «Adrian Ruthe»,
«Bogger ID»: «B123»,
«Bogger Operator»: «John Key»,
«Load Source»: «X1FE2»,
«Loading Location»: «X2FE1»,
«Load Destination»: «Main ROM»,
«Site»: «BIG KAHUNA MINE»,
«Cancelled»: false
}, {
«Record»: «111111-000019»,
«Time»: «2015-07-25 00:53:00»,
«Dir.»: «OUT»,
«Operator»: «BIG MINE CO»,
«Truck ID»: «TRK0001»,
«Truck Load (m3)»: «23.5»,
«Trailer ID»: «»,
«Trailer Load (m3)»: «»,
«Total (m3)»: «23.5»,
«Status»: «»,
«Truck Driver»: «Adrian Ruthe»,
«Bogger ID»: «B123»,
«Bogger Operator»: «John Key»,
«Load Source»: «X1FE2»,
«Loading Location»: «X2FE1»,
«Load Destination»: «Main ROM»,
«Site»: «BIG KAHUNA MINE»,
«Cancelled»: false
}
]
FechaHora DESPUÉS
OBTENER | todos los registros | |||
DESPUÉS DE | ||||
Casos prácticos | Deseas obtener todos los datos de escaneado de todos los registros posteriores a la fecha (25 ago 2015) y hora (12:48 h) | |||
Parámetros | NOMBRE | TIPO | FORMATO | EJEMPLO |
sid | cadena(6) | XXXXXX | 111111 | |
después de | cadena(19) | AAAA-MM-DD+HH:MM:SS | 2015-07-25+00:48:00 |
Notas:
‘+’ separa FECHA+TIEMPO sólo a efectos de codificación de URL.
La API leerá espacios en blanco, «%20» o «+».
URL de la solicitud: https://myscannerapi.loadscan.com/api.php?sid=111111&after=2015-07-25+00:48:00&token=5ayHUgjsa952dY37PsSkydM023OiDbgsGuS2KEydBFY9i1xJOoLeHUnuOb0Bs9dQ
Es posible que el último registro devuelto se refiera a una exploración que aún no haya finalizado y que el operador del escáner la haya cancelado a posteriori. Actualmente, si necesitas conocer con precisión el estado de cada registro a través de la API, tendrás que volver a comprobar ese último registro más adelante para ver si se canceló después de que se recuperara originalmente, y se han procesado otras exploraciones. Consulta las peticiones «Cancelado» y «Simple» más abajo para ver cómo solucionar esto.
Muestra de respuesta
[
{
«Record»: «111111-000018»,
«Time»: «2015-07-25 00:50:00»,
«Dir.»: «OUT»,
«Operator»: «BIG MINE CO»,
«Truck ID»: «TRK0001»,
«Truck Load (m3)»: «23.5»,
«Trailer ID»: «»,
«Trailer Load (m3)»: «»,
«Total (m3)»: «23.5»,
«Status»: «»,
«Truck Driver»: «Adrian Ruthe»,
«Bogger ID»: «B123»,
«Bogger Operator»: «John Key»,
«Load Source»: «X1FE2»,
«Loading Location»: «X2FE1»,
«Load Destination»: «Main ROM»,
«Site»: «BIG KAHUNA MINE»,
«Cancelled»: false
},
{
«Record»: «111111-000019»,
«Time»: «2015-07-25 00:53:00»,
«Dir.»: «OUT»,
«Operator»: «BIG MINE CO»,
«Truck ID»: «TRK0001»,
«Truck Load (m3)»: «23.5»,
«Trailer ID»: «»,
«Trailer Load (m3)»: «»,
«Total (m3)»: «23.5»,
«Status»: «»,
«Truck Driver»: «Adrian Ruthe»,
«Bogger ID»: «B123»,
«Bogger Operator»: «John Key»,
«Load Source»: «X1FE2»,
«Loading Location»: «X2FE1»,
«Load Destination»: «Main ROM»,
«Site»: «BIG KAHUNA MINE»,
«Cancelled»: false
}
]