Connecting Square Accounts

Intro language that includes hyperlink to /docs/square.

Create your Square App

Configure your Square Integration

Once you have created a Square Developer account, in the Apps dashboard, click the "+" icon to add your App.

You will be taken into the "App setup" flow where you will be prompted to enter your App name. Once entered, you will be taken into the App dashboard. In the "OAuth" tab, under "Sandbox Redirect URL", you should add https://redirect.sandbox.hurdlr.com/integrations/square/YOUR_HURDLR_CLIENT_ID/. Once you are ready to go live in the "Production" environment, you can enable the "Production" toggle on the header. Under "Production Redirect URL", you should add https://redirect.prod.hurdlr.com/integrations/square/YOUR_HURDLR_CLIENT_ID/.

Linking your users' Square accounts

Explain they need to display a CTA

What happens when CTA clicked

Etc

List your app on the Square App Marketplace (optional)

While completing the previous steps are enough to quickly launch your Square integration, if you intend to list your app on the Square App Marketplace, you will need to implement an OAuth Registration endpoint. When a prospective user finds your app on the Square App Marketplace, they will be able to install your app for the first time, which will automatically register them for your app without them needing to manually fill out any info.

  1. When the user installs your app from the Square App Marketplace, the Hurdlr API will POST relevant user information to the OAuth Registration URL of your choosing.
  2. Upon receiving this user information, your server should parse the user information and determine whether the user has already created an account with your app.
  3. If the user already has an account, you can simply respond to the POST request with the redirect_uri representing where the user should be routed.
  4. If the user hasn't created an account yet, you should create an account for the user using the information provided in the POST body. You will also want to register the user with the Hurdlr API.
  5. Once done, you should respond to the POST request with the Hurdlr access_token and the redirect_uri representing where the user should be routed once the Square App Marketplace registration flow is complete.