BarTender Cloud API Page

Use the BarTender Cloud API page to register and manage web-based (OAuth access) and console (password-based access) applications, and to view, copy, and refresh your access token.

  • Click to open the BarTender Cloud menu, then select Administration and click API Keys to display this page. 

The following options are available:

  • Register for OAuth Access: The recommended access protocol for web-based applications. Available on the Web Applications (OAuth) panel.

  • Register Application for Password-Based Access: Required when your application cannot present the BarTender Cloud login interface to users. Available on the Console Applications and Services (Password-Based) panel

  • : Displays the column chooser list so that you can select the columns that you want to be displayed in the table. The following options are available:

    • Application Name: Shows the Application Name column in the table. This option is enabled by default and cannot be changed.

    • Hide All: Hides all columns except the Application Name column, which is always displayed by default.

    • Show All: Shows all columns.

    • Created: Shows the Created column, which displays the date the application was created.

    • Auth Type: Shows the Auth Type column, which displays the type of authorization used by the application.

    • Modified: Shows the Modified column, which displays the date the application was last modified.

    • Creator: Shows the Creator column, which displays the name of the person who created the application.

    • Description: Shows the Description column, which displays the value entered into the Description field when creating or modifying the application.

    • Token Lifetime: Shows the Token Lifetime column, which displays the maximum time in minutes the application can run before a new authorization token is required.

    • Application ID: Shows the Application ID column, which displays the ID created for the application when it was itself created. Click to copy the ID to the clipboard.

  • View Access Token: Opens the Personal Access Token dialog where you can copy or refresh the BarTender Cloud API access token.

ClosedTo 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. Seagull recommends that you use the OAuth protocol for web-based applications.

  • To start the registration process for OAuth access, in the Web Applications (OAuth) section, click Register Application for OAuth Access.

ClosedTo 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, in the Console Applications and Services (Password-Based) section, click Register Application for Password-Based Access.

After you register your applications, they are listed in a table on this page.

ClosedTo edit a registration

  1. In the row for the application you want to edit, click and select Edit.

  2. In the Edit Web Application Registration dialog modify the following information as needed:

    • Name

    • Description

    • Login URI

    • Callback List

    • Logout URLs

    • Allowed Origins (CORS)

    • Allowed Web Origins

  3. Click Save.

ClosedTo delete a registration

  1. In the row for the application you want to delete, click and select Delete.

  2. In the Delete Application Registration dialog, click Delete Registration.

ClosedTo view, copy, or rotate an ID and Secret

  1. In the row for the application you want to work with, click and select View ID & Secret.

  2. To copy the ID or Secret, click .

  3. To rotate the ID or Secret, click Rotate ID & Secret.

  4. To close the dialog, click Close.

ClosedTo view, copy, or refresh your access token

  1. In the Test Credentials section, click View Access Token.

    The Personal Access Token dialog opens.

  2. To copy the access token to your clipboard, click Copy Access Token.

  3. To obtain a new access token, click Refresh Access Token.

    An access token is required to connect to the BarTender Cloud REST API. Once you obtain an access token by registering your application, BarTender Cloud automatically renews the token when it expires.

  4. To close the dialog, click Close.

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.

You can control what columns are displayed and what columns are hidden in this list by clicking and selecting the columns to show and hide from the list. The Application Name column is always displayed and cannot be hidden.

Related topics