Xero¶
The Xero connector is a Palantir-provided driver for Xero.
To create a new Xero source, follow the standard setup flow for Palantir-provided drivers, then use the sections below for Xero-specific configuration and networking. For the complete property reference, see the official Xero driver documentation ↗.
Configuration¶
The properties below are mandatory or recommended.
| Property | Required? | Description | Default |
|---|---|---|---|
AuthScheme ↗ |
Recommended | The type of authentication to use when connecting to Xero. | OAuthClient |
InitiateOAuth ↗ |
Recommended | Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. | GETANDREFRESH |
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 | The Xero API you want to access as a database schema. | ACCOUNTING |
Tenant ↗ |
Recommended | Sets the Xero organization to connect to. Can be a name or tenant ID. | — |
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 |
|---|---|
| api.xero.com | Always |
| login.xero.com | OAuth Authorization URL |
| identity.xero.com | Always. OAuth Token URL |
中文翻译¶
Xero¶
Xero连接器是Palantir提供的用于Xero的驱动程序。
要创建新的Xero数据源，请遵循Palantir提供驱动程序的标准设置流程，然后使用以下各节进行Xero特定的配置和网络设置。有关完整的属性参考，请参阅官方Xero驱动程序文档 ↗。
配置¶
以下属性为必填或推荐项。
| 属性 | 是否必填 | 描述 | 默认值 |
|---|---|---|---|
AuthScheme ↗ |
推荐 | 连接到Xero时使用的认证类型。 | OAuthClient |
InitiateOAuth ↗ |
推荐 | 指定获取或刷新OAuth访问令牌的过程，该令牌用于在已认证、已授权的用户工作时维持其访问权限。 | GETANDREFRESH |
OAuthClientId ↗ |
推荐 | 指定创建自定义OAuth应用程序时分配的客户端ID（也称为消费者密钥）。该ID用于在OAuth授权服务器上注册自定义应用程序。 | — |
OAuthClientSecret ↗ |
推荐 | 指定创建自定义OAuth应用程序时分配的客户端密钥（也称为消费者密钥）。该密钥用于在OAuth授权服务器上注册自定义应用程序。 | — |
Schema ↗ |
推荐 | 您希望作为数据库模式访问的Xero API。 | ACCOUNTING |
Tenant ↗ |
推荐 | 设置要连接的Xero组织。可以是名称或租户ID。 | — |
网络配置¶
下表列出了数据源需要能够访问才能成功运行的域名。
对于每个域名，请添加相应的出站策略。如果数据源部署在本地且无法直接从Foundry访问，请改用代理出站策略；代理主机本身也必须能够访问所列出的域名。详情请参阅使用代理作为代理服务器。
| 域名 | 是否必需 |
|---|---|
| api.xero.com | 始终必需 |
| login.xero.com | OAuth授权URL |
| identity.xero.com | 始终必需。OAuth令牌URL |