Note: This is a highly technical guide webpage. Therefore, we recommend involving your IT department when reading this. Should you have any inquiries or requests, please contact us through support@azumuta.com - we'd be happy to assist you.
What Is Simple Entry Integration?
A common use case of simple entry integration is automatic navigation to product orders. An operator can scan a product order’s barcode, and their screen will be automatically redirected to that product order, so that they can immediately start working on that product order on their device.
To enable this, we’ve created a generic Simple Entry Integration, available in the “Integrations” section of your company settings. Here’s how to reach this section.
- Click on “Settings” under “Management”.
- Click on “Integrations” under “Integrations”.
The prefilled URL /api/integrations/generic/v1/getOrderByBarcode is a generic implementation of the simple entry process. This setup allows for a straightforward flow where scanning and entering a product order identifier will open an existing product order.
Note: This only works if the product order already exists and the scanned code exactly matches the product identifier in Azumuta.
If you need more advanced functionality, such as automatically creating a product order that hasn’t existed yet, please refer to this guide section.
After setting up a Simple Entry Integration in your company settings, update the device settings where you want to use it. Navigate to the Product orders tab, and carefully review the settings highlighted below:
How to Create a Custom Simple Entry Integration
If you want to extend this process with your own custom business logic, you can create a custom integration.
When a device is configured to use simple entry, it will send a request to the URL specified in the “simpleEntryEndpoint” field. The config field can be left blank.
After scanning a barcode on the configured device, our service will send a GET request to the URL provided in the simpleEntryEndpoint field.
The request will include a query parameter named barcode , which represents the scanned code or input on the device.
Note: The barcode will be URL-encoded
Additionally, the request headers will contain an x-api-key that you can use to authenticate with the Azumuta REST API.
Request Example
Request:
url: ?barcode=
headers: { x-api-key:
After processing your custom logic, the integration should respond with a JSON object containing the identifier field. Content-type on the request should be application/json.
Response Example
{ identifier: “” }
How to Create a Product Order Automatically
A common feature request that we often receive from clients is the ability to automatically create a product order for the scanned code (if the product order hasn’t existed yet).
This can be easily achieved using a single call to the Products Create REST API: https://app.azumuta.com/docs/api/products/create
You can make a POST request to create a product endpoint using the following parameters:
-
returnExisting: true — This will not create a new product but will return the existing product in case the product order already exists.
-
activate: true — Automatically activate the product order upon creation. Activating a product order makes it visible in the operator interface. This action ensures that the associated work instructions are locked to their latest approved versions.