barxui includes a programmers interface (API) to low level functionality that allows integration of custom applications. Using the API you can:
- List various objects such as Labels, Printers & Agents
- Print 1 or more labels to PDF, PNG or to a printer via an installed Agent
Using the API you can:
- print without providing any data – labels can use :
- static values
- variables that calculate values (e.g. current date/time)
- sequence and serial number
- print proving values for prompted variable values that are normally entered by a user via the user interface, e.g. an operator name or batch number etc.
- print using data from a barxui table, optionally providing query parameters
- print providing all the data for 1 or more labels
- and more…
Examples and instructions for all these use cases follows below. The detailed API
Before using the API:
- Optionally upload a data file from CSV or Excel
- Create one or more label designs
- Optionally install an Agent
- Install the API AddOn
- Activate the API interface and generate an API Key
Note: During the trial period of your subscription you will have limited access to the API and other functionality in barxui.
Listing Labels
The API provides and endpoint to list all the available labels.
Designing Labels for API Access
The design of your labels depends on your use case.
Static Labels
This is the most basic mode for labels. All shapes on the label are static – i.e. their values do not derive from any data or variable expressions.
Using the API you can print these labels without any inputs, query parameters or data elements in the request.