BarTender Cloud API Page

Click BarTender Cloud API in the left navigation pane to display this page, which you can use to do the following: 

  • Register a web application for OAuth access. The OAuth protocol requires that the client application provide users with a BarTender Cloud sign-in form, and it grants access to only the specific client that the user is signed in to. We recommend that you use the OAuth protocol for web-based applications.

    To start the registration process for OAuth access, click Register Application for OAuth Access.

  • Register an application for password-based access. This type of access is required when your application cannot provide users with a BarTender Cloud sign-in form, which is typical for console applications and services that do not have a GUI.

    To start the registration process for password-based access, click Register Application for Password-Based Access.

  • View, copy, and rotate the application ID and secret for your registered applications.

  • View, copy, and refresh your test access token.

    You can use the test access token to test the API requests that you want to send to the server, such as cURL commands, PowerShell scripts, and JavaScript. To view the test access token, click View Access Token in the Test Credentials area. This token expires after 30 days.

After you register your applications, they are listed in a table on this page. Authorized users can use these applications to access the BarTender Cloud REST API and then use the API to automate printing processes. For more information, refer to Authentication.

The following options are available:

  • Register Application for OAuth Access: Opens the Register Web Application dialog, which you can use to register a web-based application.

  • Register Application for Password-Based Access: Opens the Register Password-Based Access dialog, which you can use to register a console application or service.

  • : Displays the column headers for the application table. In this list, click the column headers that you want to hide or show in the table.

  • : Displays the following options:

    • Edit: Opens the Edit Web Application Registration or Edit Password-Based Access dialog for the selected application so that you can make edits as needed.

    • Delete: Opens the Delete Application Registration dialog so that you can delete the selected application.

    • View ID & Secret: Displays the application ID and secret for the selected application.

  • View Access Token: Displays the Personal Access Token dialog, which includes a temporary access token that you can use to test your connection to the BarTender Cloud API. The following options are available:

    • Copy Access Token: Copies the token to the clipboard.

    • Refresh Access Token: Generates a new token.