Set up integration with BarTender Cloud

Labeling  •  Article  •  9/8/2025  •  5 min

The following procedure outlines how to integrate the Aptean Labeling extension with the BarTender Cloud.

  1. Select the Search icon , enter Labeling Setup, and then choose the related link.
    The Labeling Setup page opens.

  2. On the General FastTab, in the Caption Language field, select a language code from the dropdown.

  3. On the Communication FastTab, in the Integration Type field, select BarTender Cloud.

    The Integration Type field value cannot be left blank. If it is blank, the system displays a notification on the Role Center indicating that it is not configured.

  4. In the Bartender Region field, select a region to determine the endpoint URL. The available options are Europe (EU1), Americas (AM1), and Asia Pacific (AP1). The system updates the BarTender Region field value to AM1 by default if the field is empty when the extension is upgraded to a newer version.

    When upgrading this extension to version 2407.8.0.0, you must select a value in the Bartender Region field to avoid issues with label printing.

  5. In the Endpoint Label Software field, enter the URL of the endpoint selected in the Integration Type field to send labels.

    For more information about the use of web services integration for the creation of the endpoint URL, see How to Set Up a Web Service Integration–BarTender Support Portal.

    Picture1

  6. In the Communication Type field, select the following communication type for label batching that allows optimization of API calls when printing multiple labels.

    • Single: Send labels individually in separate API calls.
    • Combined: Group multiple labels into a single API call.

  7. On the Authentication FastTab, in the Authentication field, select one of the following authentication types:

    • Basic: The basic credentials set up are used for authentication when on a machine running the BarTender integration with a local admin, non-domain account.
      We recommend using this authentication type.
    • Anonymous: Any user can access any public content without providing login credentials to the client browser.
      We do not recommend using this authentication type for a production environment. You can use this for testing or a sandbox environment.

  8. In the User Name field, enter a user name that will be used as credentials for authentication.

  9. In the Password field, enter a password name that will be used as credentials for authentication.

  10. In the Client ID field, enter the client ID.

  11. In the Client Secret field, enter the client secret key.

You can obtain the client ID and secret key from the application ID and secret key of the relevant console application and services (Password-based) on the BarTender Cloud API. For more information, see Configuring a Console App for Password-based OAuth Access.

  1. In the Organization Name field, enter the organization's name.
  2. On the action bar, select Actions > Test Connection. The system validates the provided information and automatically updates the personal access token on the Customer Http Headers page.

When printing labels, the system checks the personal access token on the Customer Http Headers page to ensure it was generated within the last 10 hours. If the token is older than 10 hours, the system generates a new one, which remains valid for the next 10 hours. You can view the date and time of the last generated token in the TokenGeneratedTime table field.

For more information about configuring BarTender Cloud, see BarTender Cloud Setup.