Managing Access Options
Use the BarTender Cloud API page to register and manage web-based (OAuth access) and console (password-based access) applications, and machine-to-machine (server-to-server access) applications, and to view, copy, and refresh your access token.
After you register your applications, they are listed in a table on the BarTender Cloud API page. If you assign a service account to an application, the account is displayed in the Associated Service Account column in this table.
To 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 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 register a machine-to-machine application for client credentials
Use the BarTender Cloud API page to create and manage machine-to-machine (M2M) applications.
This type of access is required when you use third-party integrations, such as BarTender Print Connector for Dynamics 365 Business Central. Register a machine-to-machine application to enable secure integration access.
-
In the Machine-to-Machine (Client Credentials) section, click Register M2M Application.
-
In the Create M2M Application dialog, enter the following information:
-
Application Name: Enter a name for the application. This name must be unique within your organization. Required.
-
Description (optional): Enter a description of the application.
-
Service Account: Select the service account from which this application will inherit permissions. Required.
Create Service Account: If you need to create a service account, click this link to open the Service Accounts page.
-
Token Lifetime: Select the length of time the token is valid. Required.
-
Status: Select Active or Disabled.
-
Click Create Application.
-
Copy the ID and Secret and store those values.
To edit a registration
-
In the row for the application you want to edit, click
and select Edit.
-
Modify the following information as needed.
In the Edit Web Application Registration dialog:
-
Name
-
Description
-
Login URI
-
Callback List
-
Logout URLs
-
Allowed Origins (CORS)
-
Allowed Web Origins
In the Edit Password-Based Access dialog:
In the Edit M2M Application dialog:
-
Application Name
-
Description
-
Service Account
-
Token Lifetime
-
Click Save.
To delete a registration
-
In the row for the application you want to delete, click
and select Delete.
-
In the Delete Application Registration dialog, click Delete Registration.
To view, copy, or rotate an ID and secret
-
In the row for the application you want to work with, click
and select View ID & Secret.
-
To copy the ID or Secret, click
.
-
To rotate the ID or Secret, click Rotate ID & Secret.
-
To close the dialog, click Close.
|
|
This procedure does not pertain to machine-to-machine applications.
|
To view a machine-to-machine client ID
-
In the row for the application you want to view, click
and select View Client ID.
In the Client ID dialog you can click
to copy the client ID if necessary.
To regenerate a client secret for a machine-to-machine application
-
In the row for the application you want to view, click
and select Regenerate Client Secret.
-
Click Regenerate to acknowledge that you want to regenerate the Client Secret.
-
In the M2M (Client Credentials) dialog, click
to copy the ID and Secret, separately, and store those values.
-
Click Close.
To disable/enable a machine-to-machine application
Disabling an application prevents it from making BarTender API calls. It must be re-enabled before the application can make those calls again.
Disabling an application
-
In the row for the application you want to disable, click
and select Disable.
-
In the Disable M2M Application dialog, click Disable.
The application is disabled and (Disabled) is appended to the application's name.
Enabling an application
To delete a machine-to-machine application
-
In the row for the application you want to delete, click
and select Delete.
-
In the Delete M2M Application dialog, click Delete Application.
To view, copy, or refresh your access token
-
In the Test Credentials section, click View Access Token.
The Personal Access Token dialog opens.
-
To copy the access token to your clipboard, click Copy Access Token.
-
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.
-
To close the dialog, click Close.
|
|
This procedure does not pertain to machine-to-machine applications.
|
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