Square¶
The Square connector is a Palantir-provided driver for Square.
To create a new Square source, follow the standard setup flow for Palantir-provided drivers, then use the sections below for Square-specific configuration and networking. For the complete property reference, see the official Square driver documentation ↗.
Configuration¶
The properties below are mandatory or recommended.
| Property | Required? | Description | Default |
|---|---|---|---|
InitiateOAuth ↗ |
Recommended | Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. | REFRESH |
LocationId ↗ |
Recommended | The Id of a business location that will be set as default. | — |
OAuthClientId ↗ |
Recommended | Specifies the client Id that was assigned when the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server. | — |
OAuthClientSecret ↗ |
Recommended | Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret). This secret registers the custom application with the OAuth authorization server. | — |
Schema ↗ |
Recommended | Specify the Square server version to connect with. | v1 |
UseSandbox ↗ |
Recommended | A boolean indicating whether you are using a Sandbox account. The provider makes requests to the production environment by default. | FALSE |
Networking¶
The table below lists the domains that the source needs to be able to access in order to successfully run.
For each domain, add a corresponding egress policy. If the source is hosted on-premises and not directly reachable from Foundry, use an agent proxy egress policy instead; the agent host itself must also be able to reach the listed domains. See using an agent as a proxy for details.
| Domain | Required |
|---|---|
| connect.squareup.com | If UseSandbox=FALSE (default) |
| connect.squareupsandbox.com | If UseSandbox=TRUE |
中文翻译¶
Square¶
Square 连接器是 Palantir 提供的用于 Square 的驱动程序。
要创建新的 Square 数据源，请遵循 Palantir 提供驱动程序的标准设置流程，然后使用以下各节进行 Square 特定的配置和网络设置。有关完整的属性参考，请参阅官方 Square 驱动程序文档 ↗。
配置¶
以下属性为必填或推荐项。
| 属性 | 是否必填 | 描述 | 默认值 |
|---|---|---|---|
InitiateOAuth ↗ |
推荐 | 指定获取或刷新 OAuth 访问令牌的过程，该令牌可在经过身份验证的授权用户工作时维持其用户访问权限。 | REFRESH |
LocationId ↗ |
推荐 | 将设置为默认值的业务位置 ID。 | — |
OAuthClientId ↗ |
推荐 | 指定创建自定义 OAuth 应用程序时分配的客户端 ID（也称为消费者密钥）。此 ID 将自定义应用程序注册到 OAuth 授权服务器。 | — |
OAuthClientSecret ↗ |
推荐 | 指定创建自定义 OAuth 应用程序时分配的客户端密钥（也称为消费者密钥）。此密钥将自定义应用程序注册到 OAuth 授权服务器。 | — |
Schema ↗ |
推荐 | 指定要连接的 Square 服务器版本。 | v1 |
UseSandbox ↗ |
推荐 | 一个布尔值，指示是否使用沙盒账户。默认情况下，提供程序会向生产环境发送请求。 | FALSE |
网络设置¶
下表列出了数据源为成功运行而需要能够访问的域名。
对于每个域名，请添加相应的出站策略。如果数据源托管在本地且无法直接从 Foundry 访问，请改用代理出站策略；代理主机本身也必须能够访问列出的域名。有关详细信息，请参阅使用代理作为代理。
| 域名 | 是否必需 |
|---|---|
| connect.squareup.com | 如果 UseSandbox=FALSE（默认值） |
| connect.squareupsandbox.com | 如果 UseSandbox=TRUE |