Zoho CRM¶
The Zoho CRM connector is a Palantir-provided driver for Zoho CRM.
To create a new Zoho CRM source, follow the standard setup flow for Palantir-provided drivers, then use the sections below for Zoho CRM-specific configuration and networking. For the complete property reference, see the official Zoho CRM driver documentation ↗.
Configuration¶
The properties below are mandatory or recommended.
| Property | Required? | Description | Default |
|---|---|---|---|
Schema ↗ |
Mandatory | Specifies the Zoho CRM version the provider retrieves data from. Each version has a corresponding data model. | v4 |
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. | — |
Region ↗ |
Recommended | The Top Level Domain (TLD) in the server URL. | US |
UseCOQL ↗ |
Recommended | When true, the provider uses the Query API to retrieve data. | TRUE |
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. If UseSandbox=FALSE (default), Region connection property maps to TLD (default Region=US --> .com); APIDomain can be used when manually setting OAuthAccessToken |
| sandbox.zohoapis.\ |
If UseSandbox=TRUE |
| \ |
Always. Retrieved automatically with OAuth flow; set in AccountsServer connection property when manually providing OAuthAccessToken |
Region mappings¶
Use the following region mapping to complete the domain URL:
| Region | Endpoint |
|---|---|
| US | .com |
| Europe | .eu |
| India | .in |
| Australia | .com.au |
| Japan | .jp |
| China | .com.cn |
中文翻译¶
Zoho CRM¶
Zoho CRM 连接器是一个由 Palantir 提供的用于 Zoho CRM 的驱动程序（Palantir-provided driver）。
要创建新的 Zoho CRM 数据源，请遵循 Palantir 提供驱动程序的标准设置流程，然后使用以下各节进行 Zoho CRM 特定的配置和网络设置。有关完整的属性参考，请参阅 Zoho CRM 驱动程序官方文档 ↗。
配置（Configuration）¶
以下属性为必填或推荐项。
| 属性（Property） | 是否必填？ | 描述（Description） | 默认值（Default） |
|---|---|---|---|
Schema ↗ |
必填 | 指定提供程序从中检索数据的 Zoho CRM 版本。每个版本都有对应的数据模型。 | v4 |
InitiateOAuth ↗ |
推荐 | 指定获取或刷新 OAuth 访问令牌（access token）的过程，该令牌用于在已认证授权的用户工作时维持用户访问权限。 | REFRESH |
OAuthClientId ↗ |
推荐 | 指定创建自定义 OAuth 应用程序时分配的客户端 ID（client Id）（也称为消费者密钥）。此 ID 用于将自定义应用程序注册到 OAuth 授权服务器。 | — |
OAuthClientSecret ↗ |
推荐 | 指定创建自定义 OAuth 应用程序时分配的客户端密钥（client secret）（也称为消费者密钥）。此密钥用于将自定义应用程序注册到 OAuth 授权服务器。 | — |
Region ↗ |
推荐 | 服务器 URL 中的顶级域名（Top Level Domain, TLD）。 | US |
UseCOQL ↗ |
推荐 | 当设置为 true 时，提供程序使用查询 API（Query API）来检索数据。 | TRUE |
网络配置（Networking）¶
下表列出了数据源为成功运行而需要能够访问的域名。
对于每个域名，请添加相应的出站策略（egress policy）。如果数据源部署在本地且无法直接从 Foundry 访问，请改用代理出站策略（agent proxy egress policy）；代理主机本身也必须能够访问列出的域名。详情请参阅使用代理作为代理服务器。
| 域名（Domain） | 是否必填 |
|---|---|
| \ |
始终必填。如果 UseSandbox=FALSE（默认值），Region 连接属性映射到 TLD（默认 Region=US --> .com）；手动设置 OAuthAccessToken 时可以使用 APIDomain |
| sandbox.zohoapis.\ |
如果 UseSandbox=TRUE |
| \ |
始终必填。通过 OAuth 流程自动获取；在手动提供 OAuthAccessToken 时，在 AccountsServer 连接属性中设置 |
区域映射（Region mappings）¶
使用以下区域映射来补全域名 URL：
| 区域（Region） | 端点（Endpoint） |
|---|---|
| 美国（US） | .com |
| 欧洲（Europe） | .eu |
| 印度（India） | .in |
| 澳大利亚（Australia） | .com.au |
| 日本（Japan） | .jp |
| 中国（China） | .com.cn |