Skip to main content
Deutsch Español Français 日本語 简体中文 繁體中文

Search

Articles in this section

BarTender Cloud REST API Password-Based Authentication

Shamanth Vohra

BarTender Content Team

  • Updated

Overview

BarTender Cloud offers password-based authentication for Console Applications and Services (third-party apps) to gain access to the BarTender Cloud Rest API using your BarTender Cloud username and password.

This article offers a detailed look at how password-based authentication works in BarTender Cloud. As this is an advanced topic, this article is geared towards those individual who are already familiar with or have advanced knowledge of this subject.

Applicable to 

BarTender Cloud REST API

Information

Password-based authentication should only be enabled on a BarTender Cloud service account created for this purpose, not your personal user account. This authentication process requires sharing your service account's login credentials. You should only use it with trusted applications. 

First, you must enable password-based authentication for the BarTender Cloud account you want to use.

Do this by following the steps below:

  1. Click on Administration in the left-hand sidebar and navigate to Security > Users.

BTC_2024.10_Home_Users.png

  1. Expand the user options by selecting the vertical ellipsis icon to the right of the user in question.
  2. Click Edit.
  3. Click to check the Allow password-based API access box to enable this feature. 
BTC_2023.8_Acnt_Users_2.png
  1. Click Save at the bottom.

Registering Your Application for Password-Based Access

Once you've enabled password-based API access for your User profile, it's time to register your application with BarTender Cloud.

  1. Click on Administration in the left-hand sidebar and select API Keys.

BTC_2024.10_Home_APIKeys.png

     2. Click Register Application for Password-Based Access under Console Applications and Services (Password-Based).

     3. Complete the following fields and click Register:

    • Name: Specifies a name for the application or service. This is the "friendly" display name.

    • Description: Specifies an optional description for the application or service.

     4. Your newly registered application or service will be listed on the BarTender Cloud API property  page. 

     5. Completing registration will generate an Application ID and Application Secret. Click the verticle ellipsis icon to the right of your registered application and select View ID & Secret to view them.

This will be used alongside your BarTender Cloud username and password to generate your access token to make BarTender Cloud REST API calls. If you need to change the ID and Secret, select the Rotate ID & Secret button as seen in the above Web Registration ID and Secret dialog.

Now that configuration is complete, your third-party app will have access to your BarTender Cloud tenant space, regardless of which user is logged in.

Additional Resources

Help Documentation:

Support Articles:

Related articles