# 连接到 Freshsales
Freshsales 是一款直观的 CRM 系统，可帮助销售代表消除销售过程中的猜测工作。借助内置电话和电子邮件、任务、预约和笔记，销售代表无需在选项卡之间切换即可跟进潜在客户。可以借助管道视图更好地管理交易，促成更多交易。如果是 Freshsales 用户，则可将 AWS Glue 连接到 Freshsales 账户。可以使用 Freshsales 作为 ETL 作业中的数据来源。通过运行这些作业，可将数据从 Freshsales 传输到 AWS 服务或其他受支持的应用程序。
**Topics**
+ [AWS Glue 支持 Freshsales](freshsales-support.md)
+ [包含创建和使用连接的 API 操作的策略](freshsales-configuring-iam-permissions.md)
+ [配置 Freshsales](freshsales-configuring.md)
+ [配置 Freshsales 连接](freshsales-configuring-connections.md)
+ [从 Freshsales 实体读取内容](freshsales-reading-from-entities.md)
+ [Fressales 连接选项](freshsales-connection-options.md)
+ [Freshsales 的限制](freshsales-connection-limitations.md)
# AWS Glue 支持 Freshsales
AWS Glue 对 Freshsales 的支持情况如下：
**是否支持作为来源？**
是。可以使用 AWS Glue ETL 作业查询 Freshsales 中的数据。
**是否支持作为目标？**
否。
**支持的 Freshsales API 版本**
支持以下 Freshsales API 版本：
+ v1.0
# 包含创建和使用连接的 API 操作的策略
以下示例策略描述了创建和使用连接所需的 AWS IAM 权限。如果您要创建新角色，请创建包含以下内容的策略：
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"glue:ListConnectionTypes",
"glue:DescribeConnectionType",
"glue:RefreshOAuth2Tokens",
"glue:ListEntities",
"glue:DescribeEntity"
],
"Resource": "*"
}
]
}
```
------
如果您不想使用上述方法，也可以使用以下托管 IAM 策略：
+ [AWSGlueServiceRole](https://console.aws.amazon.com/iam/home#policies/arn:aws:iam::aws:policy/service-role/AWSGlueServiceRole) – 授予对各种 AWS Glue 进程代表您运行所需的资源的访问权限。这些资源包括 AWS Glue、Amazon S3、IAM、CloudWatch Logs 和 Amazon EC2。如果您遵循此策略中指定的资源的命名约定，则 AWS Glue 进程具有所需的权限。此策略通常附加到在定义爬网程序、作业和开发终端节点时指定的角色。
+ [AWSGlueConsoleFullAccess](https://console.aws.amazon.com/iam/home#policies/arn:aws:iam::aws:policy/AWSGlueConsoleFullAccess)：当策略所附加到的身份使用 AWS 管理控制台时，授予对 AWS Glue 资源的完全访问权限。如果遵循此策略中指定的资源的命名约定，则用户具有完全控制台功能。此策略通常附加到 AWS Glue 控制台的用户。
# 配置 Freshsales
必须满足以下要求，才能使用 AWS Glue 从 Freshsales 传输数据：
## 最低要求
以下是最低要求：
+ 拥有一个 Fressales 账户。
+ 拥有一个用户 API 密钥。
如果满足这些要求，就可以将 AWS Glue 连接到 Freshsales 账户。对于常见连接，无需在 Freshsales 中执行其他操作。
# 配置 Freshsales 连接
Freshsales 支持自定义身份验证。
有关生成自定义身份验证所需 API 密钥的 Freshsales 公共文档，请参阅 [Authentication](https://developer.freshsales.io/api/#authentication)。
要配置 Freshsales 连接，请执行以下操作：
1. 在 AWS Secrets Manager 中，创建一个包含以下详细信息的密钥：
1. 对于客户管理型关联应用程序，密钥应包含关联应用程序的 API 密钥，且以 `apiSecretKey` 为键。密钥还需要包含另一个键值对：以 `apiKey` 为键，以 `token` 为值。
1. 注意：必须在 AWS Glue 中为连接创建一个密钥。
1. 在 AWS Glue Glue Studio 中，按照以下步骤在**数据连接**下创建连接：
1. 选择**数据来源**时，请选择 Freshsales。
1. 提供想要连接到的 Freshsales 账户的 `INSTANCE_URL`。
1. 选择 AWS Glue 可以代入并有权执行以下操作的 AWS IAM 角色：
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"secretsmanager:DescribeSecret",
"secretsmanager:GetSecretValue",
"secretsmanager:PutSecretValue",
"ec2:CreateNetworkInterface",
"ec2:DescribeNetworkInterfaces",
"ec2:DeleteNetworkInterface"
],
"Resource": "*"
}
]
}
```
------
1. 在 AWS Glue 中选择您要用于此连接的 `secretName`，然后放置令牌。
1. 如果要使用网络，请选择网络选项。
1. 向与您的 AWS Glue 作业关联的 IAM 角色授予读取 `secretName` 的权限。
# 从 Freshsales 实体读取内容
**先决条件**
要从中读取内容的 Freshsales 对象。您将需要对象名称。
**源支持的实体**：
| 实体 | 可以筛选 | 支持限制 | 支持排序依据 | 支持 Select \$1 | 支持分区 |
| --- | --- | --- | --- | --- | --- |
| 账户 | 支持 | 是 | 是 | 是 | 是 |
| 联系人 | 支持 | 是 | 是 | 是 | 是 |
**示例：**
```
freshSales_read = glueContext.create_dynamic_frame.from_options(
connection_type="freshsales",
connection_options={
"connectionName": "connectionName",
"ENTITY_NAME": "entityName",
"API_VERSION": "v1.0"
}
```
**Freshsales 实体和字段详细信息**：
Freshsales 提供了端点，用于为所支持实体动态获取元数据。因此，可在数据类型级别捕获运算符支持。
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_cn/glue/latest/dg/freshsales-reading-from-entities.html)
## 对查询进行分区
**基于筛选器的分区**：
如果您想在 Spark 中利用并发，可以提供其他 Spark 选项：`PARTITION_FIELD`、`LOWER_BOUND`、`UPPER_BOUND` 和 `NUM_PARTITIONS`。使用这些参数，原始查询将被拆分为 `NUM_PARTITIONS` 个子查询，这些子查询可以由 Spark 任务同时执行。
+ `PARTITION_FIELD`：用于对查询进行分区的字段的名称。
+ `LOWER_BOUND`：所选分区字段的**包含**下限值。
对于“日期时间”字段，我们接受 ISO 格式的值。
有效值示例：
```
"2024-09-30T01:01:01.000Z"
```
+ `UPPER_BOUND`：所选分区字段的**排除**上限值。
+ `NUM_PARTITIONS`：分区的数量。
示例：
```
freshSales_read = glueContext.create_dynamic_frame.from_options(
connection_type="freshsales",
connection_options={
"connectionName": "connectionName",
"ENTITY_NAME": "entityName",
"API_VERSION": "v1",
"PARTITION_FIELD": "Created_Time"
"LOWER_BOUND": " 2024-10-15T21:16:25Z"
"UPPER_BOUND": " 2024-10-20T21:25:50Z"
"NUM_PARTITIONS": "10"
}
```
# Fressales 连接选项
以下是 Freshsales 的连接选项：
+ `ENTITY_NAME`（字符串）：（必填）用于读取。Freshsales 中对象的名称。
+ `API_VERSION`（字符串）：（必填）用于读取。要使用的 Freshsales Rest API 版本。
+ `SELECTED_FIELDS`（列表<字符串>）–默认：empty(SELECT \$1)。用于读取。您想要为对象选择的列。
+ `FILTER_PREDICATE`（字符串）– 默认：空。用于读取。应采用 Spark SQL 格式。
+ `QUERY`（字符串）– 默认：空。用于读取。完整的 Spark SQL 查询。
+ `PARTITION_FIELD`（字符串）– 用于读取。用于分区查询的字段。
+ `LOWER_BOUND`（字符串）– 用于读取。所选分区字段的包含下限值。
+ `UPPER_BOUND`（字符串）– 用于读取。所选分区字段的排除上限值。
+ `NUM_PARTITIONS`（整数）– 默认：1。用于读取。要读取的分区数。
+ `INSTANCE_URL`（字符串）– 用于读取。有效的 Freshsales 实例 URL。
# Freshsales 的限制
以下是 Freshsales 的限制或说明：
+ 在 Freshsales 中，API 速率限制为每个账户每小时 1000 个 API 请求（请参阅 [Errors](https://developer.freshsales.io/api/#error)）。但此限制可通过企业版订阅方案延长（请参阅 [plan comparison](https://www.freshworks.com/crm/pricing-compare/)）。