GPoS API Setup

GPoS API Setup

This article applies to GPoS 1.66 and higher, and Total Control Premier 2.13 and higher. Screenshots are taken from Total Control Premier 2.13.

GPoS communicates with Total Control Premier Cloud Edition via an API to retrieve Customer data, process Vouchers and post transaction data. This is done using the web address of TCPCE, using an API user account with a specific Role and Permissions that, when logged in, point GPoS in the right direction.

Total Control Premier Cloud Edition

1. Click Users - the Users module will appear displaying links to the Users and Clerks section
Sidebar - Users

Users - Users Screen

Create the GPoS API Role

1. Click User Levels (Roles) & Security (Permissions) - the Roles list will appear


Roles List Screen
2. Click Add
Roles List - Add New Role
3. Enter a suitable Name for the role
 Add New Role
4. Set Available to people of type to "GPoS API Role"
5. Make sure Active is ticked, then click Save - the Permissions and Users tabs will appear at the top of the window
Save New Role

Save - New Tabs
6. Click the Permissions tab - a list of all Permissions will appear, and this may take a minute or two
 Role Permissions
7. Expand the API Entity, and tick Explicit against the GPoS Customer Record API Permission - the tickbox will be replaced by a spinning circle while the permission is applied; once the Permission has been applied, the tickbox will appear with a tick through it
8. Close the User Role record by clicking the cross in the top left corner of the window - you will see the new Role appearing in the Roles list
New Role Listed

Create the GPoS API User

1. Click View Users - the Users list will appear
Users Screen - Users Button

Users List Screen
2. Click Add
Add New User Button
3. Enter the required details for the user account - the User Name and Full Name can be different, but the User Name must match the User Name specified in GPoS System Options as described below
 Add New User
4. Set Person Type to "GPoS Customer Record API"

5. Make sure Active is ticked, then click Save - the Send Activation button will appear next to the Email field and the Associate Person to Role tab will appear at the top of the window
Add New User - Save Button

Save New User - New Tabs
6. Activate the user account as per any other user account requiring access to TCPCE and make sure that the user account can log in correctly, then return to the Users list and edit the GPoS API user
7. Click the Associate Person to Role tab
 Associate Role To User
8. Click the Fidelity Systems Organisation to display the available Roles
 Fidelity Systems Organisation
9. Tick Associated against the previously created Role - the tickbox will be replaced by a spinning circle while the Role is associated; once the Role has been associated, the tickbox will appear with a tick through it
 Associate GPoS API Role
10. Close the User record by clicking the cross in the top left corner of the window - you will see the new User appearing in the Users list
 Users List Screen - New User Listed

An email address is required for the activation link to be sent, so it must either be a valid email address or one that can be captured with something like MailTrap.

GPoS System Options

The following System Options need to be configured to point GPoS at the API and set the Discount to be linked and reported on when Vouchers are applied to the basket:

Category
Option Code
Description
Explanation / Value
CloudOffice
800
TCPCloud: API URL
The web address used to access TCPCE, eg "http://webserver:8080"/
CloudOffice
801
TCPCloud: API User
The User Name of the GPoS API account created in TCPCE as described above
CloudOffice
802
TCPCloud: API Password
The Password of the GPoS API account created in TCPCE as described above
CloudOffice
806
TCPCloud: Customer Record Discount
The GPoS Discount to be displayed on transactions and reported on when Vouchers are applied to the basket
GPoS discount setup: Subtotal % with a Halo of -1

    • Related Articles

    • Total Control Premier Cloud Edition Setup

      This article applies to Total Control Premier version 2.11 and higher - screenshots are taken from Total Control Premier version 2.11. Before You Begin Total Control Premier Cloud Edition is a web application running on Internet Information Services, ...

    • New Features Active Computers

      A new applet called 'Active Computers' has been added allowing users with permission to view details regarding computers with TCP installed. Adding applets to the system can be found by Clicking Here The applet shows the following information:- ...

    • Total Control Premier Server Setup

      This article applies to Total Control Premier version 2.09 and higher - screenshots are taken from Total Control Premier version 2.11. Requirements An instance of Microsoft SQL Server 2008R2 or higher is required; we would always recommend using the ...

    • Total Control Premier Client Setup

      This article applies to Total Control Premier version 2.11 and higher - screenshots are taken from Total Control Premier version 2.11. Requirements An Administrator account, or a user account with permissions to install software and services, and ...

    • Total Control Premier Cloud / Desktop Edition 2.11

      Introduction to Total Control Premier Cloud Edition In addition to the standard desktop installation of Total Control Premier, you are now able to host a cloud edition of the software. Beginning in version 2.10 with a subset of the existing desktop ...