Square 3rd Party OAuth Setup


Below we outline how to connect Matillion ETL to your Square account using a simple OAuth setup. The process can be understood in 2 parts - collecting details from your Square account and then entering those details into Matillion ETL. This process is necessary before beginning to use the Square Query component.

 

Collecting Details From Square

To configure your OAuth for Square, you will need 2 pieces of information from your Square account; an Application ID and a Application Secret.
  1. Ensure you are logged into the Square Developer Portal with the account you wish to connect to Matillion ETL.
  2. Select the App you wish to connect with. Most likely you will want to create a new app with the '+New Application' button.
  3. Give your new application a name and click ' Create Application'.
  4. With your app selected, browse to the 'Credentials' tab (default) and make a note of the string under 'Application ID'
  5. Now browse to the 'OAuth' tab and make note of the string under 'Application Secret'

  6. Under 'Redirect URL' you need to enter the address of your Matillion ETL instance in the following format:
 
https://<Matillion ETL Instance Address>/oauth_redirect.html

e.g.

https://instance.matillion.com/oauth_redirect.html
Note: It is vital that your Matillion ETL instance has a secure HTTP address for connection with Square.

You are now ready to enter your details into Matillion ETL by following the below section.
 

Configuring the Matillion ETL Instance


Log into your Matillion ETL instance and from the Project Menu select 'Manage OAuth'. Use the + button at the lower-left of the Manage OAuth window to add a new OAuth method.

From the 'Service' dropdown menu select 'Square' and name the entry whatever you please. Now find that same entry from the list in the Manage OAuth window and select the green cogwheel icon beside it to edit the OAuth details.


Fill in the Client ID and Client Secret with the Application ID and Application Secret, respectively, that we found in the previous section. Hit 'Next'. On the next screen you will find your Callback URL. If you did not complete your 'Redirect URL' in the previous section, copy the Callback URL and paste it into that field on the Square Developer Portal.

Note: The Callback URL, and thus your Matillion ETL instance, must be from a secured HTTP address (HTTPS) and authorization with Square will fail otherwise. 

 
When all is complete, click the 'Authorization link'. Wait a few moments and if all has succeeded,  you should be presented with an 'Authorization successful' message.


You are now free to close the window. If the OAuth was unsuccessful, ensure your Square account is set up correctly and that the details entered are correct. If this still fails, do not hesitate to contact Matillion ETL support for hands-on help.

Now that your OAuth is configured, it can be used by selecting the entry name from the Square Query component's 'Authentication' property. Also note that this component requires a default LocationId being defined before running, details of which can be found in the component documentation.