Authenticate with Square

You can authenticate with Square to create your own instance of the Square element through the UI or through APIs. Once authenticated, you can use the element instance to access the different functionality offered by the Square platform.

Authenticate Through the UI

Use the UI to authenticate with Square and create an element instance. Square authentication follows the typical OAuth 2.0 framework and you will need to sign in to Square as part of the process.

If you are configuring events, see the Events section.

To authenticate an element instance:

1. Sign in to Cloud Elements, and then search for Square in our Elements Catalog.
2. Hover over the element card, and then click Authenticate.
3. Enter a name for the element instance.
4. Optionally type or select one or more Element Instance Tags to add to the authenticated element instance.
5. Click Create Instance.
6. Provide your Square credentials, and then allow the connection.

After successfully authenticating, we give you several options for next steps. Make requests using the API docs associated with the instance, map the instance to a virtual data resource, or use it in a formula template.

Authenticate Through API

Authenticating through API is similar to authenticating via the UI. Instead of clicking and typing through a series of buttons, text boxes, and menus, you will instead send a request to our instance endpoint. The end result is the same, though: an authenticated element instance with a token and id.

Authenticating through API follows a multi-step OAuth 2.0 process that involves:

• Getting a redirect URL. This URL sends users to the vendor to log in to their account.
• Authenticating users and receiving the authorization grant code. After the user logs in, the vendor makes a call back to the specified url with an authorization grant code.
• Authenticating the element instance. Using the authorization code from the vendor, authenticate with the vendor to create an element instance at Cloud Elements.

Getting a Redirect URL

Use the following API call to request a redirect URL where the user can authenticate with the service provider. Replace {keyOrId} with the element key, square.

curl -X GET /elements/{keyOrId}/oauth/url?apiKey=<api_key>&apiSecret=<api_secret>&callbackUrl=<url>&siteAddress=<url>

Query Parameters

Example cURL

curl -X GET \
  'https://api.cloud-elements.com/elements/api-v2/elements/square/oauth/url?apiKey=Rand0MAP1-key&apiSecret=fak3AP1-s3Cr3t&callbackUrl=https://www.mycoolapp.com/auth&state=square' \

Example Response

Use the oauthUrl in the response to allow users to authenticate with the vendor.

{
"oauthUrl": "https://connect.squareup.com/oauth2/authorize?response_type=code&redirect_uri=https%3A%2F%2Fhttpbin.org%2Fget&state=square&client_id=sq0idp-3fu9k3r2rBJzd3ZpnMeM-Q",
"element": "square"
}

Authenticating Users and Receiving the Authorization Grant Code

Provide the response from the previous step to the users. After they authenticate, Square provides the following information in the response:

• code
• state

Authenticating the Element Instance

Use the /instances endpoint to authenticate with Square and create an element instance. If you are configuring events, see the Events section.

To authenticate an element instance:

1. Construct a JSON body as shown below (see Parameters):

   {
     "element": {
       "key": "square"
     },
     "providerData": {
       "code": "<AUTHORIZATION_GRANT_CODE>"
     },
     "configuration": {
       "oauth.callback.url": "<Square Redirect URL>",
       "oauth.api.key": "<Square Application ID>",
       "oauth.api.secret": "<Square Application Secret>"
     },
     "tags": [
       "<Add_Your_Tag>"
     ],
     "name": "<INSTANCE_NAME>"
   }
   

2. Call the following, including the JSON body you constructed in the previous step:

   POST /instances
   

   Note: Make sure that you include the User and Organization keys in the header. See the Overview for details.

3. Locate the token and id in the response and save them for all future requests using the element instance.

Example cURL

curl -X POST \
  https://api.cloud-elements.com/elements/api-v2/instances \
  -H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
  -H 'content-type: application/json' \
  -d '{
  "element": {
    "key": "square"
  },
  "providerData": {
    "code": "xxxxxxxxxxxxxxxxxxxxxxx"
  },
  "configuration": {
    "oauth.callback.url": "https;//mycoolapp.com",
    "oauth.api.key": "xxxxxxxxxxxxxxxxxx",
    "oauth.api.secret": "xxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "tags": [
    "Docs"
  ],
  "name": "API Instance"
}'

Parameters

API parameters not shown in Cloud Elements are in code formatting.

Example Response for an Authenticated Element Instance

In this example, the instance ID is 12345 and the instance token starts with "ABC/D...". The actual values returned to you will be unique: make sure you save them for future requests to this new instance.

{
  "id": 12345,
  "name": "API Instance",
  "createdDate": "2017-08-07T18:46:38Z",
  "token": "ABC/Dxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "element": {
      "id": 8374,
      "name": "Square",
      "key": "square",
      "description": "Add a Square Instance to connect your existing Square account to the Employees Hub, allowing you to manage roles, timesheets, employees, etc. across multiple Employee Elements. You will need your Square  account information to add an instance.",
      "image": "https://www.seeklogo.net/wp-content/uploads/2012/12/square-logo-vector.png",
      "active": true,
      "deleted": false,
      "typeOauth": false,
      "trialAccount": false,
      "resources": [ ],
      "transformationsEnabled": true,
      "bulkDownloadEnabled": true,
      "bulkUploadEnabled": true,
      "cloneable": true,
      "extendable": false,
      "beta": false,
      "authentication": {
          "type": "oauth2"
      },
      "extended": false,
      "hub": "employee",
      "protocolType": "http",
      "parameters": [],
      "private": false
    },
    "elementId": 8374,
    "tags": [
        "Docs"
    ],
    "provisionInteractions": [],
    "valid": true,
    "disabled": false,
    "maxCacheSize": 0,
    "cacheTimeToLive": 0,
    "providerData": {    },
    "configuration": {    },
    "eventsEnabled": false,
    "traceLoggingEnabled": false,
    "cachingEnabled": false,
    "externalAuthentication": "none",
    "user": {
        "id": 12345
      }
}