jprdonnelly/airbyte
1
0
Fork 0
mirror of synced 2025-12-31 06:05:12 -05:00
Code Issues Packages Projects Releases Wiki Activity
Files
9f6963ccfcddd7a573c4ca0ff94de41ce6175cc0
airbyte/docs/integrations/sources/square.md
ParthG21 67a8c05b7f 🐛 Source Square: fix display order of spec fields (#28019) 
* Removed comma from the value of order field for square source connector specification, which was causing it to be a String instead of an Integer

* increment connector version

* add changelog entry

---------

Co-authored-by: Sunny Hashmi <6833405+sh4sh@users.noreply.github.com>
2023-07-10 15:10:04 -04:00

113 lines
7.6 KiB
Markdown
Raw Blame History

# Square
This page contains the setup guide and reference information for the Square source connector.
## Prerequisites
To set up the Square source connector with Airbyte, you'll need to create your Square Application and use Personal token or Oauth access token.
## Setup guide
### Step 1: Set up Square
1. Create [Square Application](https://developer.squareup.com/apps)
2. Obtain [Personal token](https://developer.squareup.com/docs/build-basics/access-tokens) or [Oauth access token](https://developer.squareup.com/docs/oauth-api/create-urls-for-square-authorization).
### Step 2: Set up the Square connector in Airbyte
### For Airbyte Cloud:
1. [Log into your Airbyte Cloud](https://cloud.airbyte.com/workspaces) account.
2. In the left navigation bar, click **Sources**. In the top-right corner, click **+ New source**.
3. On the Set up the source page, enter the name for the Square connector and select **Square** from the Source type dropdown.
4. Choose authentication method:
* Api-Key
* Fill in API key token with "Access token" from Square Application settings page (Credentials on the left)
* Oauth authentication
* Fill in Client ID and Client secret with data from Square Application settings page (Oauth on the left)
* Fill in refresh token with one obtained during the authentication process
5. Choose if your account is sandbox
6. Choose start date
7. Choose if you would like to include Deleted objects (for streams: Items, Categories, Discounts, Taxes)
### For Airbyte OSS:
1. Navigate to the Airbyte Open Source dashboard.
2. Set the name for your source.
3. On the Set up the source page, enter the name for the Square connector and select **Square** from the Source type dropdown.
4. Choose authentication method:
* Api-Key
* Fill in API key token with "Access token" from Square Application settings page (Credentials on the left)
* Oauth authentication
* Fill in Client ID and Client secret with data from Square Application settings page (Oauth on the left)
* Fill in refresh token with one obtained during the authentication process
5. Choose if your account is sandbox
6. Choose start date
7. Choose if you would like to include Deleted objects (for streams: Items, Categories, Discounts, Taxes)
## Supported sync modes
The Square source connector supports the following [ sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes):
* [Full Refresh - Overwrite](https://docs.airbyte.com/understanding-airbyte/connections/full-refresh-overwrite/)
* [Full Refresh - Append](https://docs.airbyte.com/understanding-airbyte/connections/full-refresh-append)
* [Incremental - Append](https://docs.airbyte.com/understanding-airbyte/connections/incremental-append)
* [Incremental - Deduped History](https://docs.airbyte.com/understanding-airbyte/connections/incremental-deduped-history)
## Supported Streams
* [Items](https://developer.squareup.com/explorer/square/catalog-api/search-catalog-objects) \(Incremental\)
* [Categories](https://developer.squareup.com/explorer/square/catalog-api/search-catalog-objects) \(Incremental\)
* [Discounts](https://developer.squareup.com/explorer/square/catalog-api/search-catalog-objects) \(Incremental\)
* [Taxes](https://developer.squareup.com/explorer/square/catalog-api/search-catalog-objects) \(Incremental\)
* [ModifierLists](https://developer.squareup.com/explorer/square/catalog-api/search-catalog-objects) \(Incremental\)
* [Payments](https://developer.squareup.com/reference/square_2022-10-19/payments-api/list-payments) \(Incremental\)
* [Refunds](https://developer.squareup.com/reference/square_2022-10-19/refunds-api/list-payment-refunds) \(Incremental\)
* [Locations](https://developer.squareup.com/explorer/square/locations-api/list-locations)
* [Team Members](https://developer.squareup.com/reference/square_2022-10-19/team-api/search-team-members)
* [List Team Member Wages](https://developer.squareup.com/explorer/square/labor-api/list-team-member-wages)
* [Customers](https://developer.squareup.com/explorer/square/customers-api/list-customers)
* [Shifts](https://developer.squareup.com/reference/square/labor-api/search-shifts)
* [Orders](https://developer.squareup.com/reference/square/orders-api/search-orders)
## Connector-specific features & highlights
Useful links:
* [Square API Explorer](https://developer.squareup.com/explorer/square)
* [Square API Docs](https://developer.squareup.com/reference/square)
* [Square Developer Dashboard](https://developer.squareup.com/apps)
## Performance considerations (if any)
No defined API rate limits were found in Square documentation however considering [this information](https://stackoverflow.com/questions/28033966/whats-the-rate-limit-on-the-square-connect-api/28053836#28053836) it has 10 QPS limits. The connector doesn't handle rate limits exceptions, but no errors were raised during testing.
Exponential [Backoff](https://developer.squareup.com/forums/t/current-square-api-rate-limit/449) strategy recommended.
## Data type map
| Integration Type | Airbyte Type | Notes |
|:-----------------|:-------------|:------|
| `string` | `string` | |
| `integer` | `integer` | |
| `array` | `array` | |
| `object` | `object` | |
| `boolean` | `boolean` | |
## Changelog
| Version | Date | Pull Request | Subject |
|:--------|:-----------|:---------------------------------------------------------|:---------------------------------------------------------------------------|
| 1.1.2 | 2023-07-10 | [28019](https://github.com/airbytehq/airbyte/pull/28019) | fix display order of spec fields |
| 1.1.1 | 2023-06-28 | [27762](https://github.com/airbytehq/airbyte/pull/27762) | Update following state breaking changes |
| 1.1.0 | 2023-05-24 | [26485](https://github.com/airbytehq/airbyte/pull/26485) | Remove deprecated authSpecification in favour of advancedAuth |
| 1.0.1 | 2023-05-03 | [25784](https://github.com/airbytehq/airbyte/pull/25784) | Fix Authenticator |
| 1.0.0 | 2023-05-03 | [25784](https://github.com/airbytehq/airbyte/pull/25784) | Fix Authenticator |
| 0.2.2 | 2023-03-22 | [22867](https://github.com/airbytehq/airbyte/pull/22867) | Specified date formatting in specification |
| 0.2.1 | 2023-03-06 | [23231](https://github.com/airbytehq/airbyte/pull/23231) | Publish using low-code CDK Beta version |
| 0.2.0 | 2022-11-14 | [19369](https://github.com/airbytehq/airbyte/pull/19369) | Migrate to low code (YAML); update API to version 2022-10-19; update docs |
| 0.1.4 | 2021-12-02 | [6842](https://github.com/airbytehq/airbyte/pull/6842) | Added oauth support |
| 0.1.3 | 2021-12-06 | [8425](https://github.com/airbytehq/airbyte/pull/8425) | Update title, description fields in spec |
| 0.1.2 | 2021-11-08 | [7499](https://github.com/airbytehq/airbyte/pull/7499) | Remove base-python dependencies |
| 0.1.1 | 2021-07-09 | [4645](https://github.com/airbytehq/airbyte/pull/4645) | Update \_send\_request method due to Airbyte CDK changes |
| 0.1.0 | 2021-06-30 | [4439](https://github.com/airbytehq/airbyte/pull/4439) | Initial release supporting the Square API |
Reference in New Issue View Git Blame Copy Permalink