How to use IBM App Connect with Square

Connecting to Square

Complete the connection fields that you see in the App Connect Designer Catalog page or flow editor. If necessary, work with your Square administrator to obtain these values.

Square connection fields:

1. Log in to your Square account.
2. To generate a personal access token:
   1. On the Square Developer Dashboard page, choose your application. To create a new application, see Create an account and application on the Square Developer page.
   2. On the sidebar, click Credentials.
   3. Copy the Sandbox or Production Access token (personal access token) value based on your requirement and save it somewhere safe.
   4. For more information, see Get a personal access token on the Square Developer page.
3. To generate client ID, client secret, and redirect URI:
   1. On the Square Developer Dashboard page, choose your application. To create a new application, see Create an account and application on the Square Developer page.
   2. On the sidebar, click OAuth.
   3. Copy the Sandbox or Production Application ID (client ID) value based on your requirement and save it somewhere safe.
   4. Click Show, then copy your Sandbox or Production Application secret value based on your requirement and save it somewhere safe.
   5. On the Redirect URL box, enter the URL (URI) that redirects the seller authorization to your production application.
   6. Click Save.
   7. For more information, see Create the redirect URL on the Square Developer page.
4. To generate an access token and refresh token from the client ID and client secret, see Create the Redirect URL and Square Authorization Page URL and Connect your Application to a Seller's Account Using OAuth on the Square Developer page.

To connect to a Square endpoint from the App Connect Designer Catalog page for the first time, expand Square, then click Connect. For more information, see Managing accounts.

General considerations

Before you use App Connect Designer with Square, take note of the following considerations:

• For more information about Square Idempotency key, see Idempotency on the Square Developer page.

• (General consideration) You can see lists of the trigger events and actions that are available on the Catalog page of the App Connect Designer.

  For some applications, the events and actions in the catalog depend on the environment and whether the connector supports configurable events and dynamic discovery of actions. If the application supports configurable events, you see a Show more configurable events link under the events list. If the application supports dynamic discovery of actions, you see a Show more link under the actions list.

• (General consideration) If you are using multiple accounts for an application, the set of fields that is displayed when you select an action for that application can vary for different accounts. In the flow editor, some applications always provide a curated set of static fields for an action. Other applications use dynamic discovery to retrieve the set of fields that are configured on the instance that you are connected to. For example, if you have two accounts for two instances of an application, the first account might use settings that are ready for immediate use. However, the second account might be configured with extra custom fields.

Events and actions

Square events

These events are for changes in this application that trigger a flow to start completing the actions in the flow.

Square actions

Your flow completes these actions on this application.