Shopify

The Shopify connector is a Palantir-provided driver for Shopify.

To create a new Shopify source, follow the standard setup flow for Palantir-provided drivers, then use the sections below for Shopify-specific configuration and networking. For the complete property reference, see the official Shopify driver documentation ↗.

Configuration

The properties below are mandatory or recommended.

Property	Required?	Description	Default
ShopURL ↗	Mandatory	The full URL of your Shopify shop.	https://{shopURL}
AccessToken ↗	Recommended	Admin API Access Token for a custom app.	—
AuthScheme ↗	Recommended	The type of authentication to use when connecting to Shopify.	AccessToken
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
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 Shopify server version to connect with.	GRAPHQL-2024-07

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
\	Always. ShopURL connection property

---

中文翻译

# Shopify

<!-- BEGIN GENERATED:intro -->

Shopify 连接器是一个 [Palantir 提供的驱动程序](https://palantir.com/docs/foundry/data-integration/foundry-provided-drivers/)，用于连接 Shopify。

要创建新的 Shopify 数据源，请遵循 [Palantir 提供驱动程序的标准设置流程](https://palantir.com/docs/foundry/data-integration/foundry-provided-drivers/#setup)，然后使用以下各节进行 Shopify 特定的配置和网络设置。有关完整的属性参考，请参阅 [官方 Shopify 驱动程序文档 ↗](https://cdn.cdata.com/help/FOK/jdbc/pg_connectionj.htm)。

<!-- END GENERATED:intro -->

<!-- BEGIN GENERATED:configuration -->

## 配置

以下属性为必填或推荐项。

| 属性 | 是否必填 | 描述 | 默认值 |
|---|---|---|---|
| [`ShopURL` ↗](https://cdn.cdata.com/help/FOK/jdbc/RSBShopify_p_ShopURL.htm) | 必填 | 您的 Shopify 店铺的完整 URL。 | `https://{shopURL}` |
| [`AccessToken` ↗](https://cdn.cdata.com/help/FOK/jdbc/RSBShopify_p_AccessToken.htm) | 推荐 | 自定义应用的 Admin API 访问令牌。 | — |
| [`AuthScheme` ↗](https://cdn.cdata.com/help/FOK/jdbc/RSBShopify_p_AuthScheme.htm) | 推荐 | 连接到 Shopify 时使用的身份验证类型。 | `AccessToken` |
| [`InitiateOAuth` ↗](https://cdn.cdata.com/help/FOK/jdbc/RSBShopify_p_InitiateOAuth.htm) | 推荐 | 指定获取或刷新 OAuth 访问令牌的过程，该令牌可在经过身份验证的授权用户工作时维持其访问权限。 | `REFRESH` |
| [`OAuthClientId` ↗](https://cdn.cdata.com/help/FOK/jdbc/RSBShopify_p_OAuthClientId.htm) | 推荐 | 指定创建自定义 OAuth 应用时分配的客户端 ID（也称为消费者密钥）。此 ID 用于在 OAuth 授权服务器上注册自定义应用。 | — |
| [`OAuthClientSecret` ↗](https://cdn.cdata.com/help/FOK/jdbc/RSBShopify_p_OAuthClientSecret.htm) | 推荐 | 指定创建自定义 OAuth 应用时分配的客户端密钥（也称为消费者密钥）。此密钥用于在 OAuth 授权服务器上注册自定义应用。 | — |
| [`Schema` ↗](https://cdn.cdata.com/help/FOK/jdbc/RSBShopify_p_Schema.htm) | 推荐 | 指定要连接的 Shopify 服务器版本。 | `GRAPHQL-2024-07` |

<!-- END GENERATED:configuration -->

<!-- BEGIN GENERATED:networking -->

## 网络设置

下表列出了数据源为成功运行而需要能够访问的域名。

对于每个域名，请添加相应的 [出站策略](https://palantir.com/docs/foundry/administration/configure-egress/)。如果数据源托管在本地且无法从 Foundry 直接访问，请改用 [代理出站策略](https://palantir.com/docs/foundry/administration/configure-egress/#agent-proxy-egress-policies)；代理主机本身也必须能够访问列出的域名。有关详细信息，请参阅 [使用代理作为代理](https://palantir.com/docs/foundry/data-connection/agent-proxy/)。

| 域名 | 是否必需 |
|--- |--- |
| \<ShopURL> | 始终必需。ShopURL 连接属性 |

<!-- END GENERATED:networking -->