FreshBooks¶
The FreshBooks connector is a Palantir-provided driver for FreshBooks.
To create a new FreshBooks source, follow the standard setup flow for Palantir-provided drivers, then use the sections below for FreshBooks-specific configuration and networking. For the complete property reference, see the official FreshBooks driver documentation ↗.
Configuration¶
The properties below are mandatory or recommended.
| Property | Required? | Description | Default |
|---|---|---|---|
AccountId ↗ |
Recommended | The Account Id to connect to. If a value is not specified, the first one returned will be used. | — |
CallbackURL ↗ |
Recommended | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. | https://localhost:33333/ |
InitiateOAuth ↗ |
Recommended | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. | REFRESH |
OAuthClientId ↗ |
Recommended | The client Id assigned when you register your application with an OAuth authorization server. | — |
OAuthClientSecret ↗ |
Recommended | The client secret assigned when you register your application with an 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 |
|---|---|
| api.freshbooks.com | Always |
| my.freshbooks.com | Always |
中文翻译¶
FreshBooks¶
FreshBooks 连接器是 Palantir 为 FreshBooks 提供的驱动程序。
要创建新的 FreshBooks 数据源，请遵循 Palantir 提供驱动程序的标准设置流程，然后使用以下各节进行 FreshBooks 特定的配置和网络设置。有关完整的属性参考，请参阅 FreshBooks 驱动程序官方文档 ↗。
配置¶
以下属性为必填或推荐设置。
| 属性 | 是否必填 | 描述 | 默认值 |
|---|---|---|---|
AccountId ↗ |
推荐 | 要连接的账户 ID。如果未指定值，将使用返回的第一个账户。 | — |
CallbackURL ↗ |
推荐 | 身份验证时返回的 OAuth 回调 URL。此值必须与您在应用设置中指定的回调 URL 一致。 | https://localhost:33333/ |
InitiateOAuth ↗ |
推荐 | 设置此属性可在连接时启动获取或刷新 OAuth 访问令牌的流程。 | REFRESH |
OAuthClientId ↗ |
推荐 | 在 OAuth 授权服务器上注册应用程序时分配的客户端 ID。 | — |
OAuthClientSecret ↗ |
推荐 | 在 OAuth 授权服务器上注册应用程序时分配的客户端密钥。 | — |
网络配置¶
下表列出了数据源成功运行所需访问的域名。
对于每个域名，请添加相应的出口策略。如果数据源部署在本地且无法直接从 Foundry 访问，请改用代理出口策略；代理主机本身也必须能够访问所列域名。详情请参阅使用代理作为代理服务器。
| 域名 | 必需条件 |
|---|---|
| api.freshbooks.com | 始终需要 |
| my.freshbooks.com | 始终需要 |