Abra las páginas de Azumuta App desde otra aplicación

Actualizado

Nota: Este artículo es técnico, por lo que le recomendamos que involucre a alguien con la experiencia técnica adecuada. Si tiene preguntas o necesita ayuda con la configuración, póngase en contacto con support@azumuta.com.

Otra aplicación, como un sistema ERP, un MES o una aplicación canvas de Microsoft Power Apps, puede abrir una página de la Azumuta App en un navegador. Por ejemplo, un botón en su aplicación abre la instrucción de trabajo para el pedido actual. La página autentica al operario con un token de sesión de un solo uso.

Iniciar sesión con un token de sesión

  1. Su integración solicita un token de sesión con POST /api/v1/auth/sessionTokens. Envía la API key de un dispositivo API con el ámbito Session tokens en la cabecera x-api-key. El cuerpo nombra al operario (loginIdentifier) y al dispositivo normal donde se ejecuta la página (deviceId).
  2. Su aplicación abre la URL de la página con el token en el parámetro de consulta sessionToken.
  3. La página autentica al operario en ese dispositivo y elimina el token de la barra de direcciones.

Un token de sesión funciona solo una vez y caduca tras 60 segundos. Solicite un nuevo token cada vez que su aplicación abra una página. No ponga la API key en la URL de la página.

La página usa la configuración del dispositivo normal, por ejemplo Instruction step list is closed by default y Automatically open on first instruction step. Para cambiar esto, edite el dispositivo.

Para un ejemplo completo con la configuración del dispositivo, consulte Connect Microsoft Power Apps to Azumuta with device API tokens. Para la petición y la respuesta, consulte la documentación REST API en la aplicación.

Páginas

Page path Opens
/workinstruction/WORK_INSTRUCTION_ID A standalone work instruction preview. Answers and completion are not saved as a recording.
/view/WORK_INSTRUCTION_ID A work instruction for consultation. Normally creates a consultation recording; if consultation recording is disabled for the instruction, opens a standalone preview instead.
/recording/RECORDING_ID An existing recording
/product/PRODUCT_ORDER_NUMBER A product order, identified by its order number
/article/ARTICLE_NUMBER An article preview, identified by its article number
/article/default/ARTICLE_CATEGORY_ID A preview of the default article of an article category
/spot?treeNodeId=TREE_NODE_ID A spot, identified by its tree node ID

Para grabar la ejecución, abra una grabación existente con /recording/RECORDING_ID, o abra la orden de producto con /product/PRODUCT_ORDER_NUMBER y seleccione su instrucción de trabajo.

Coloque la ruta después del host de su espacio de trabajo y reemplace los marcadores de posición. Use el Work instruction ID, no el Tree node ID. Consulte Using your data in the REST API para encontrar los IDs.

Agregue el token de sesión y las opciones siguientes como parámetros de consulta. Comience el primer parámetro con ? y cada parámetro siguiente con &. Codifique cada valor para URL. Por ejemplo:

https://YOUR_AZUMUTA_HOST/recording/RECORDING_ID?sessionToken=SESSION_TOKEN
https://YOUR_AZUMUTA_HOST/spot?treeNodeId=TREE_NODE_ID&sessionToken=SESSION_TOKEN

El operario debe tener acceso al contenido que abra la página.

Opciones para todas las páginas

Parameter Value Effect
sessionToken A session token Signs the operator in. Required.
virtualKeyboard true Shows an on-screen keyboard when the operator selects a text field. Use this on touchscreens without a keyboard.
bgColor A hex color, for example %23004080 Sets the background color of the top bar. Encode # as %23.
fgColor A hex color, for example %23FFFFFF Sets the text color of the top bar.
rightButtonsOffset A number of pixels Moves the buttons on the right of the top bar to the left. Use this when your application shows its own content in that corner, such as a close button.
fastForward false Turns off fast forward.

Opciones por página

Work instruction and consultation

Estas opciones se aplican a /workinstruction/... y /view/....

Parameter Value Effect
version A version index Opens that version instead of the latest approved version. The index starts at 0, so version=9 opens version 10.
backButtonUrl An http or https URL Shows a back button in the top bar. The button opens this URL.
closeWindowOnFinish true When the operator finishes, the page opens backButtonUrl. Without backButtonUrl, the page closes its browser tab, but only if a script opened that tab.

Estas opciones se aplican solo a /workinstruction/...:

Parameter Value Effect
variants Variant codes, separated by commas Shows the work instruction for these variants.
parameters A JSON object with parameter values Gives values to the parameters in the work instruction, the same as the parameters of a product order.

Recording

Parameter Value Effect
backButtonUrl An http or https URL Shows a back button in the top bar. The button opens this URL.
closeOnFinish true When the operator finishes, the page opens backButtonUrl. Without backButtonUrl, the page closes its browser tab if a script opened that tab. Otherwise it asks the operator to close the tab.
spotId A spot ID Links issues that the operator creates during the recording to this spot.

Spot

Parameter Value Effect
treeNodeId The tree node ID of a spot Opens this spot. Required.
defaultTab explore, audits, articles, products or asset-tasks Opens this tab first. The default is explore.

La página de la orden de producto y las páginas de artículos no tienen otras opciones.