Square¶
Getting Started with Square¶
The Square modules allow you to monitor, create, update, or search transactions, customers, orders and refunds in your Square account.
Prerequisites
- A Square account
In order to use Square with Ibexa Connect, it is necessary to have a Square account. If you do not have one, you can create a Square account at squareup.com.
Note
The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!
Connecting Square to Ibexa Connect¶
To connect your Square account to Ibexa Connect follow the general instructions for Connecting to services.
After you click the Continue button, Ibexa Connect will redirect you to the Square website where you will be prompted to grant Ibexa Connect access to your account.
Confirm the dialog by clicking the Allow button.
The connection has been established. You can now proceed with setting up the Square module.
Make an API Call¶
Allows you to perform a custom API call.
URL |
Enter a path relative to | For the list of available endpoints, refer to the Square Connect API documentation. |
Method
Select the HTTP method you want to use:
GET to retrieve information for an entry.
POST to create a new entry.
PUT to update/replace an existing entry.
PATCH to make a partial entry update.
DELETE to delete an entry.
Headers
Enter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query String
Enter the request query string.
Body
Enter the body content for your API call.
Example of Use - List Customers¶
The following API call returns all customers:
Matches of the search can be found in the module's Output under Bundle > Body > customers. In our example, 4 customers were returned:
