

# Freshsales에 연결
<a name="connecting-to-data-freshsales"></a>

Freshsales는 영업 담당자가 영업에서 추측을 배제할 수 있도록 도와주는 직관적인 CRM입니다. 전화와 이메일, 작업, 약속, 메모가 기본으로 제공되므로 영업 담당자는 잠재 고객에 대한 후속 조치를 위해 여러 탭을 전환할 필요가 없습니다. 파이프라인 보기를 통해 거래를 더 잘 관리하고 더 많은 거래를 성사시킬 수 있습니다. Freshsales 사용자인 경우 Freshsales 계정에 AWS Glue를 연결할 수 있습니다. 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)
+ [Freshsales 연결 옵션](freshsales-connection-options.md)
+ [Freshsales 제한 사항](freshsales-connection-limitations.md)

# AWS Glue의 Freshsales 지원
<a name="freshsales-support"></a>

AWS Glue에서는 다음과 같이 Freshsales를 지원합니다.

**소스로 지원되나요?**  
예. AWS Glue ETL 작업을 사용하여 Freshsales에서 데이터를 쿼리할 수 있습니다.

**대상으로서 지원되나요?**  
아니요.

**지원되는 Freshsales API 버전**  
다음 Freshsales API 버전이 지원됩니다.
+ v1.0

# 연결을 생성하고 사용하기 위한 API 작업이 포함된 정책
<a name="freshsales-configuring-iam-permissions"></a>

다음 샘플 정책은 연결을 생성하고 사용하는 데 필요한 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 Management Console을 사용하는 경우 AWS Glue 리소스에 대한 전체 액세스 권한을 부여합니다. 이 정책에 지정된 리소스의 이름 변환을 따르면 사용자는 콘솔 전체 용량을 소유합니다. 이 정책은 보통 AWS Glue 콘솔의 사용자에게 해당됩니다.

# Freshsales 구성
<a name="freshsales-configuring"></a>

AWS Glue를 사용하여 Freshsales에서 데이터를 전송하려면 먼저 다음 요구 사항을 충족해야 합니다.

## 최소 요구 사항
<a name="freshsales-configuring-min-requirements"></a>

다음은 최소 요구 사항입니다.
+ Freshsales 계정이 있습니다.
+ 사용자 API 키가 있습니다.

이러한 요구 사항을 충족하면 Freshsales 계정에 AWS Glue를 연결할 준비가 된 것입니다. 일반적인 연결의 경우 Freshsales에서 다른 작업을 수행하지 않아도 됩니다.

# Freshsales 연결 구성
<a name="freshsales-configuring-connections"></a>

Freshsales는 사용자 지정 인증을 지원합니다.

사용자 지정 인증에 필요한 API 키 생성에 대한 퍼블릭 Freshsales 설명서는 [Authentication](https://developer.freshsales.io/api/#authentication)을 참조하세요.

Freshsales 연결을 구성하는 방법:

1. AWS Secrets Manager에서 다음 세부 정보로 보안 암호를 생성합니다.

   1. 고객 관리형 연결된 앱의 경우 보안 암호는 키 역할을 하는 `apiSecretKey`과 함께 연결된 앱 API를 포함해야 합니다. 또한 보안 암호에는 `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 엔터티에서 읽기
<a name="freshsales-reading-from-entities"></a>

**사전 조건**

읽으려는 Freshsales 객체입니다. 객체 이름이 필요합니다.

**소스에 대해 지원되는 엔터티**:


| 개체 | 필터링 가능 | 제한 지원 | 정렬 기준 지원 | Select \$1 지원 | 분할 지원 | 
| --- | --- | --- | --- | --- | --- | 
| Accounts | 예 | 예 | 예 | 예 | 예 | 
| Contacts | 예 | 예 | 예 | 예 | 예 | 

**예시:**

```
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/ko_kr/glue/latest/dg/freshsales-reading-from-entities.html)

## 분할 쿼리
<a name="freshsales-reading-partitioning-queries"></a>

**필터 기반 분할**:

Spark에서 동시성을 활용하려는 경우 추가 Spark 옵션(`PARTITION_FIELD`, `LOWER_BOUND`, `UPPER_BOUND`, `NUM_PARTITIONS`)을 제공할 수 있습니다. 이러한 파라미터를 사용하면 Spark 작업에서 동시에 실행할 수 있는 `NUM_PARTITIONS`개의 하위 쿼리로 원래 쿼리가 분할됩니다.
+ `PARTITION_FIELD`: 쿼리 분할에 사용할 필드의 이름입니다.
+ `LOWER_BOUND`: 선택한 파티션 필드의 하한 값(**경계 포함**).

  Datetime 필드의 경우 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"
     }
```

# Freshsales 연결 옵션
<a name="freshsales-connection-options"></a>

다음은 Freshsales의 연결 옵션입니다.
+ `ENTITY_NAME`(문자열) - (필수) 읽기에 사용됩니다. Freshsales에서의 객체 이름입니다.
+ `API_VERSION`(문자열) - (필수) 읽기에 사용됩니다. 사용하려는 Freshsales Rest API 버전입니다.
+ `SELECTED_FIELDS`(List<String>) - 기본값: 비어 있습니다(SELECT \$1). 읽기에 사용됩니다. 객체에 대해 선택할 열.
+ `FILTER_PREDICATE`(문자열) - 기본값: 비어 있습니다. 읽기에 사용됩니다. Spark SQL 형식이어야 합니다.
+ `QUERY`(문자열) - 기본값: 비어 있습니다. 읽기에 사용됩니다. 전체 Spark SQL 쿼리.
+ `PARTITION_FIELD`(문자열) - 읽기에 사용됩니다. 쿼리 분할에 사용할 필드입니다.
+ `LOWER_BOUND`(문자열) - 읽기에 사용됩니다. 선택한 파티션 필드의 하한 값(경계 포함).
+ `UPPER_BOUND`(문자열) - 읽기에 사용됩니다. 선택한 파티션 필드의 상한 값(경계 제외).
+ `NUM_PARTITIONS`(정수) - 기본값: 1. 읽기에 사용됩니다. 읽을 파티션 수.
+ `INSTANCE_URL`(문자열) - 읽기에 사용됩니다. 유효한 Freshsales 인스턴스 URL입니다.

# Freshsales 제한 사항
<a name="freshsales-connection-limitations"></a>

다음은 Freshsales의 제한 사항 또는 참고 사항입니다.
+ Freshsales에서 API 속도 제한은 계정당 시간당 1,000개의 API 요청으로 설정되어 있습니다([오류](https://developer.freshsales.io/api/#error) 참조). 단, 이 제한은 엔터프라이즈 구독 요금제로 확장할 수 있습니다([플랜 비교](https://www.freshworks.com/crm/pricing-compare/) 참조).