Set up Square in UAT

Before you can pull commerce data from companies using Square, you need to set up an integration in Codat's environments, starting with UAT.

You'll need to:

  • Login to the Codat Portal in UAT.
  • Register a Square application on Square's developer portal.
  • Retrieve your secure credentials.
  • Add your secure credentials to the Codat portal in UAT.
  • Enable your test Square integration.
  • Check your sync settings.

📘

Can I use live commerce data for testing?

We recommend that you start by using Square's sandbox so that you can retrieve and check sample data. You can also make sure that you're happy with the link flow customer journey.

Register your application and retrieve your credentials

📘

Developer account details

  • If you already have a Square developer account, have your account details to hand.

  • If you don't, create an account before you start registration.

Register your Square application on Square's developer portal

  1. Go to the Square developer portal and select Developer Dashboard to sign in.
  2. On the Applications page, select Create your first application, or select + if you've already registered other applications.
  3. Enter a name for your application. Your customers see this when they authorise your connection to their commerce data.
  4. Select Save.

Retrieve your secure credentials for the Square sandbox

  1. On the application you've just created, select Open to show your secure credentials.
  2. In the left pane, select OAuth.
  3. In the Sandbox Redirect URL box, enter https://square-uat.codat.io/oauth/callback.
  4. Select Save.
  5. Keep the OAuth page open in a separate browser tab to easily copy the Sandbox Application ID and Sandbox Application Secret to the Codat portal.

Add your secure credentials to the Codat portal

  1. Open the Codat Portal and log in.
  2. Go to Integrations > Commerce.
  3. Find Square, and select the Manage button next to it.
  4. From the OAuth page on the Square website, copy and paste the:
  • Sandbox Application ID value into Application ID.
  • Sandbox Application Secret value into Application Secret.
  1. In the Codat portal, select Save.
  2. Go back to Integrations > Commerce, and use the toggle to update the Square integration from Disabled to Enabled.

Check your sync settings in the Codat portal

If this is your first commerce integration, update your sync settings to enable commerce data types.

Now follow the instructions in Test Square to test your setup by pulling sample data from the Square or Codat sandbox.


Did this page help you?