BigCommerce¶
The BigCommerce connector is a Palantir-provided driver for BigCommerce.
To create a new BigCommerce source, follow the standard setup flow for Palantir-provided drivers, then use the sections below for BigCommerce-specific configuration and networking. For the complete property reference, see the official BigCommerce driver documentation ↗.
Configuration¶
The properties below are mandatory or recommended.
| Property | Required? | Description | Default |
|---|---|---|---|
StoreId ↗ |
Mandatory | The store hash for this BigCommerce account. | — |
AuthScheme ↗ |
Recommended | The type of authentication to use when connecting to BigCommerce. | PersonalAccessToken |
IncludeCustomFields ↗ |
Recommended | A boolean indicating if you would like to include custom fields in the column listing. | TRUE |
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. | — |
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 |
|---|---|
| login.bigcommerce.com | Always. Auth and token endpoints |
| api.bigcommerce.com | Always |
| store-{STORE_ID}.mybigcommerce.com | Always. Looks like it is used in some cases where you are inserting/updating data |
中文翻译¶
BigCommerce¶
BigCommerce 连接器是 Palantir 为 BigCommerce 提供的官方驱动程序。
要创建新的 BigCommerce 数据源，请遵循Palantir 官方驱动程序的标准设置流程，然后使用以下各节进行 BigCommerce 特定的配置和网络设置。有关完整的属性参考，请参阅BigCommerce 驱动程序官方文档 ↗。
配置¶
以下属性为必填或推荐项。
| 属性 | 是否必填 | 描述 | 默认值 |
|---|---|---|---|
StoreId ↗ |
必填 | 此 BigCommerce 账户的商店哈希值。 | — |
AuthScheme ↗ |
推荐 | 连接 BigCommerce 时使用的身份验证类型。 | PersonalAccessToken |
IncludeCustomFields ↗ |
推荐 | 布尔值，表示是否在列列表中包含自定义字段。 | TRUE |
InitiateOAuth ↗ |
推荐 | 指定获取或刷新 OAuth 访问令牌的过程，该令牌在已验证授权的用户工作时维持其访问权限。 | REFRESH |
OAuthClientId ↗ |
推荐 | 指定创建自定义 OAuth 应用程序时分配的客户端 ID（也称为消费者密钥）。此 ID 将自定义应用程序注册到 OAuth 授权服务器。 | — |
OAuthClientSecret ↗ |
推荐 | 指定创建自定义 OAuth 应用程序时分配的客户端密钥（也称为消费者密钥）。此密钥将自定义应用程序注册到 OAuth 授权服务器。 | — |
网络设置¶
下表列出了数据源为成功运行而需要能够访问的域名。
对于每个域名，请添加相应的出站策略。如果数据源部署在本地且无法直接从 Foundry 访问，请改用代理出站策略；代理主机本身也必须能够访问列出的域名。详情请参阅使用代理作为代理服务器。
| 域名 | 是否必需 |
|---|---|
| login.bigcommerce.com | 始终需要。用于身份验证和令牌端点 |
| api.bigcommerce.com | 始终需要 |
| store-{STORE_ID}.mybigcommerce.com | 始终需要。在某些插入/更新数据的情况下需要使用 |