Connect to Square Data in RunMyProcess through Connect Cloud

Ready to get started?

Learn more or sign up for a free trial:

CData Connect



Use CData Connect Cloud to create an OData API for Square and connect to Square data in Akorbi Digital RunMyProcess.

Akorbi Digital RunMyProcess makes it easy to create applications for complex business processes, such as budget application and contract management. CData Connect creates a virtual database for Square and can be used to generate an OData API (natively consumable in RunMyProcess) for Square. By pairing RunMyProcess with the CData Connect Cloud, you get true cloud-to-cloud connectivity to all your SaaS and cloud-based Big Data and NoSQL sources - no need to migrate your data or write your own integrations. Simply connect to Connect Cloud from RunMyProcess as you would any other REST service and get instant, live access to your Square data.

In this article, we walk through connecting to Square from CData Connect and accessing Square data through an OData feed in RunMyProcess.

Configuring Connect Cloud

To work with live Square data in RunMyProcess, we need to connect to Square from Connect Cloud, provide user access to the new virtual database, and create OData endpoints for the Square data.

Add a Connect Cloud User

Create a User to connect to Square from RunMyProcess through Connect Cloud.

  1. Click Users -> Add
  2. Configure a User
  3. Click Save Changes and make note of the Authtoken for the new user

Connect to Square from Connect Cloud

CData Connect Cloud uses a straightforward, point-and-click interface to connect to data sources and generate APIs.

  1. Open Connect Cloud and click Databases
  2. Select "Square" from Available Data Sources
  3. Enter the necessary authentication properties to connect to Square

    Square uses the OAuth authentication standard. To authenticate using OAuth, you will need to register an app with Square to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL. See the "Getting Started" chapter of the help documentation for a guide to using OAuth.

    Additionally, you must specify the LocationId. You can retrieve the Ids for your Locations by querying the Locations table. Alternatively, you can set the LocationId in the search criteria of your query.

  4. Click Test Database
  5. Click Privileges -> Add and add the new user (or an existing user) with the appropriate permissions (SELECT is all that is required for RunMyProcess).

Add Square OData Endpoints in Connect Cloud

After connecting to Square, create OData Endpoints for the desired table(s).

  1. Click OData -> Tables -> Add Tables
  2. Select the Square database
  3. Select the table(s) you wish to work with and click Next
  4. (Optional) Edit the resource to select specific fields and more
  5. Save the settings

(Optional) Configure Cross-Origin Resource Sharing (CORS)

When accessing and connecting to multiple domains from an application, such as Ajax, you might violate the limitations of cross-site scripting. In that case, configure the CORS settings in OData -> Settings.

  • Enable cross-origin resource sharing (CORS): ON
  • Allow all domains without '*': ON
  • Access-Control-Allow-Methods: GET, PUT, POST, OPTIONS
  • Access-Control-Allow-Headers: Authorization

Save the changes to the settings.

Sample URLs for OData Feeds

Once you have configured a connection to Square, created a user, and created OData endpoints in Connect Cloud, you can access OData feeds for Square data. Below, you will see the URLs to access tables and the list of tables. For information on accessing the tables, you can navigate to the API page for Connect Cloud (click the API link on the top right of Connect Cloud Web page). For the URLs, you will need the URL of Connect Cloud, likely in the form: https://www.cdatacloud.net/myinstance/. Since we are working with Angular, we will append the @json parameter to the end of URLs that do not return JSON data by default.

Table         URL
Entity (table) List https://www.cdatacloud.net/myinstance/api.rsc/
Metadata for table Refunds http://www.cdatacloud.net/myinstance/api.rsc/Refunds/$metadata?@json
Refunds http://www.cdatacloud.net/myinstance/api.rsc/Square_Refunds

As with standard OData feeds, if you wish to limit the fields returned, you can add a $select parameter to the query, along with other standard OData URL parameters, such as $filter, $orderby, $skip, and $top. See the help documentation for more information on supported OData queries.

Configure Connect Cloud to Connect to Square

To connect to Square data from RunMyProcess, you need to configure Square access from your Connect Cloud instance. This means creating a user, connecting to Square, adding OData endpoints, and (optionally) configuring CORS.

Add a Connect Cloud User

Create a Cloud Connect User to connect to Square from RunMyProcess.

  1. Click Users -> Add
  2. Configure a User
  3. Click Save Changes and make note of the Authtoken for the new user

Connect to Square from Connect Cloud

CData Connect Cloud uses a straightforward, point-and-click interface to connect to data sources and generate APIs.

  1. Open Connect Cloud and click Databases
  2. Select "Square" from Available Data Sources
  3. Enter the necessary authentication properties to connect to Square.

    Square uses the OAuth authentication standard. To authenticate using OAuth, you will need to register an app with Square to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL. See the "Getting Started" chapter of the help documentation for a guide to using OAuth.

    Additionally, you must specify the LocationId. You can retrieve the Ids for your Locations by querying the Locations table. Alternatively, you can set the LocationId in the search criteria of your query.

  4. Click Test Database
  5. Click Privileges -> Add, and add the new user (or an existing user) with the appropriate permissions (SELECT is all that is required for RunMyProcess)

Add Square OData Endpoints in Connect Cloud

After connecting to Square, create an OData Endpoint for the desired table(s).

  1. Click OData -> Tables -> Add Tables
  2. Select the Square database
  3. Select the table(s) you wish to work with and click Next
  4. (Optional) Edit the resource to select specific fields and more
  5. Save the settings

(Optional) Configure Cross-Origin Resource Sharing (CORS)

When accessing and connecting to multiple domains from an application, such as Ajax, you might violate the limitations of cross-site scripting. In that case, configure the CORS settings in OData -> Settings.

  • Enable cross-origin resource sharing (CORS): ON
  • Allow all domains without '*': ON
  • Access-Control-Allow-Methods: GET, PUT, POST, OPTIONS
  • Access-Control-Allow-Headers: Authorization

Save the changes to the settings.

Retrieve Square Data from RunMyProcess DigitalSuite Studio

With the connection to Square and OData endpoints created, we are ready to add Square data to RunMyProcess for retrieval.

Create a Provider

  1. Log into RunMyProcess and open DigitalSuite Studio.
  2. Click Resources to bring up the Resources page, then select then the CONNECTORS tab.   
  3. Click the + (New Provider) button to create a new provider, choose the project to use, then click Confirm.
  4. In the provider settings page, configure the following properties.
    • URL:Set the OData endpoint in the CData Connect Endpoints page.e.g. https://www.cdatacloud.net/myinstance/api.rsc/
    • Authentication Schema:Select Login/Password.
    • Login:Specify the CData Connect User name configured above.
    • Password:Specify the Authtoken of the user.
  5. Fill in the same properties in the ACCEPTANCE and TEST tabs. Note: You can copy the configured settings by clicking 'Copy this configuration button,' then pasting the content in the new tab by clicking 'Paste previously copied configuration.'
  6. Click Save to save the properties.

Retrieve Square Data by Creating a Connector

  1. In the CONNECTORS tab, click the button with three dots to create the provider, then select Add connector from the menu.
  2. In the following page, set Connector URL to the OData endpoint configured in Connect Cloud.e.g. odataendpoint/
  3. Click Save then Launch to test the connector execution. Click Launch test to execute. The process is successful if you get the JSON response of your configured table information.

More Information & Free Trial

Now, you have created a provider and connector to retrieve Square data. For more information on creating OData feeds from Square (and more than 200 other data sources), visit the Connect Cloud page. Sign up for a free trial and start working with live Square data in RunMyProcess.