Troubleshooting the BarTender Cloud REST API
Overview
Occasionally, problems will arise with the BarTender Cloud REST API. There are several troubleshooting steps you can take when you get an error to try and resolve the problem.
Applicable to
BarTender Cloud
Information
Verify the URL
Increase Error Message Verbosity
When you append the following variable to the end of your API call, the response will include additional detail which can be useful when trying to identify an error source:
- Wait=60s
The URL for the Action API will look as follows:
https://am1.bartendercloud.com/api/actions?MessageCount=1&MessageSeverity=Info&wait=60s
Verify Available Printers
Use a GET request to get a list of your Printer IDs to use for the Printer parameter in the script.
Explore the documentation for more information:
Refresh BarTender Cloud Print Controller
Refresh the Print Controller when your print job fails even though you cannot find an error in your API call script.
In order to Refresh your BarTender Cloud Print Controller:
- Access the Print Dialog by double-clicking a label in BarTender Cloud > Print Console.
- Click Configure after selecting a printer to be taken to the Print Gateway.
- In the Print Gateway click the Edit icon for the BarTender Cloud Print Controller.
- Click Save.
Update Bearer Token
If the API response displays an Unauthorized error message even though the bearer token hasn't expired, you may need to update the token. To do so, retrieve the token from BarTender Cloud and reenter it into your application.
For more information on how to do this, use the linked article below:
Additional Resources
BarTender Cloud REST API Overview
The URL format for API calls should include the following variables by default:
The URL for the Action API will look as follows:
https://am1.bartendercloud.com/api/actions?MessageCount=1&MessageSeverity=Info
For more information on the different REST APIs available for BarTender Cloud and their respective Endpoints, look at the following documentation: REST API Overview and Help.