Square api key & connect

To enable your Square integration to make requests to the Utilmate API, you'll need to create an access token (API Key).  This token is required when you connect to Square in Utilmate  (Maintenance menu, System Configuration and select Add On's).

Tip: An access token is a unique identifier that is passed between computer programs allowing them to communicate with each other.  When a request is made, Square matches the token you entered in Utilmate to the one Square has stored, in order to authenticate and identify the requestor and ensure that they have the appropriate permissions.

How to create an access token (API Key)

Go to the Square Developer portal and sign in (you will require your Square account credentials).

If you have an existing application connection, click the Open button to obtain your API keys.  If you need to create a new application connection, click the + button and complete the steps.

Tip: You may want to have separate applications for different businesses you may operate.

In the left-hand pane, choose Credentials.

At the top of the page, choose Production mode to get your keys.  In the Production Access token box click on Show, and then copy your tokens.  These tokens need to be entered into your Square Connect screen in Utilmate.

Production Application ID is your public key
Production Access token is your private key

In the left-hand pane, choose Locations.

At the top of the page, choose Production mode to view your Location ID.  The Location ID identifies, and manages transactions, and other business operations specific to each merchant's business/es. 

Copy the Location ID as it needs to be entered into your Square Connect screen in Utilmate.

Enter access token (API Key) into Utilmate

To connect and enter your access token (API key), log into Utilmate and go to the Add On's screen in the Maintenance menu, System Configuration.  Click on the Square button.

Click on the Connect button.

Paste your public key (Production Application ID), private key (Production Access token) and location key (Location ID) then click connect.  Success!  You've now connected to Square and can start taking payments.