고급 자동화 앱에서 API 라이브러리 사용하기

고급 자동화 앱은 특정 조건이 충족될 때 특정 트리거에서 실행되는 작업을 설정할 수 있게 해줍니다. 고급 자동화 앱은 Freshchat 마켓플레이스에서 사용할 수 있습니다. 여기를 클릭하여 확인하세요. 

예를 들어, Freshdesk에서 티켓을 생성하고 사용자 정의 필드를 업데이트하거나 WhatsApp에서 템플릿 메시지를 자동으로 보낼 수 있습니다. 

고급 자동화 앱 설정에 대해 더 알아보세요.

자동화의 일환으로 설정한 작업은 나열된 순서대로 실행됩니다. 앱은 첫 번째로 일치하는 자동화를 확인하고 실행합니다. 자동화의 일환으로 설정할 수 있는 다양한 유형의 작업이 있습니다. API 트리거는 가장 강력하고 다재다능한 작업 중 하나입니다. 요청 유형을 설정하고, API 엔드포인트를 지정하며, 사용하는 인증을 설정하고, 사용자 정의 헤더, 인코딩 형식 및 콘텐츠 본문의 정보를 사용할 수 있습니다.

고급 자동화 앱에서 API를 설정하려면 먼저 설정 > 고급 > API 및 사용자 정의 플레이스홀더에서 토글해야 합니다. 이 문서는 고급 자동화 앱에서 사용할 수 있는 API 라이브러리를 설정하는 방법을 설명합니다. 사용자 정의 플레이스홀더 사용에 대해 더 알아보세요.

• API 설정
• API 트리거를 사용한 자동화 설정
• 예시
• HandlebarsJS

API 설정

1. 시작하기 전에 설정 > 고급 > API 및 사용자 정의 플레이스홀더에서 API 및 플레이스홀더를 켰는지 확인하세요.
   
   
   
2. 여기에서 모든 API를 한 곳에서 구성하고, 고급 자동화 앱에서 작업을 설정할 때마다 여러 번 사용할 수 있습니다.
   
   
3. 토글을 켜면 API 라이브러리 및 사용자 정의 플레이스홀더 아이콘이 표시됩니다. API 라이브러리 아이콘 > API 생성을 클릭하세요.
   
   
   
   
4. API 이름과 모델 이름을 지정하세요. API 이름은 참조용입니다. 모델 이름은 API 응답을 저장합니다. 다른 API나 후속 작업에서 API 응답에 액세스하려면 모델 이름을 사용하세요.
   
   
5. 요청 유형을 선택하세요. 각 서드파티 앱이 요청 유형을 다르게 사용할 수 있지만, 대부분의 애플리케이션은 다음과 같은 표준 방법을 따릅니다:
   • GET 요청은 일반적으로 하나 또는 모든 리소스를 검색하는 데 사용됩니다.
   • POST 요청은 일반적으로 새로운 리소스를 생성합니다.
   • PUT 및 PATCH 요청은 리소스를 업데이트하는 데 사용됩니다.
   • DELETE 요청은 일반적으로 리소스를 삭제하는 데 사용됩니다.
     
     
6. 연결할 앱의 API 엔드포인트 URL을 입력하세요. URL을 플레이스홀더를 사용하여 동적으로 만들 수 있습니다.
   • 예를 들어, 티켓에 메모를 추가하려면 어떤 티켓에 메모를 추가할지 지정해야 합니다. URL은 다음과 같습니다: https://acme.freshdesk.com/api/v2/tickets/{{ticket.id}}/notes 플레이스홀더 {{ticket.id}}와 함께.
     
     
7. 사용할 인증을 선택하세요. 사용자 정의 헤더, API 키 또는 사용자 이름-비밀번호 인증을 포함할 수 있습니다. 사용자 정의 헤더는 보안 세부 정보, API 버전 세부 정보 등을 전달합니다. 사용자 정의 헤더는 지정된 형식 X-Sample-CustomHeader1: VALUE에 따라 헤더-값 쌍으로 입력해야 합니다. 
   
   

   참고:	헤더에 공백이 포함된 경우 트리거가 실행되지 않습니다. 그러나 헤더 끝에 공백이 입력되면 무시됩니다.

   
   
   • 하나 이상의 값을 포함하는 헤더는 구분 기호로 구분해야 합니다(쉼표 및 콜론은 구분 기호로 사용할 수 없음). 두 번째 헤더를 추가하려면 다음 줄에 사용자 정의 헤더와 값 쌍을 입력하세요.
     
     
8. 기존의 기본 플레이스홀더를 사용하거나 이러한 인증 필드에 대해 설정한 사용자 정의 플레이스홀더를 사용하여 동적으로 만들 수 있습니다. 사용자 정의 플레이스홀더 사용에 대해 더 읽어보세요.
   
   

   참고:	고급 자동화 앱을 위한 Freshdesk 통합을 기본으로 제공하지만, 다른 제품과도 사용할 수 있습니다. 인증 정보를 사용하여 사용자 정의 플레이스홀더를 정의하고 이를 작업의 일환으로 API에서 사용하세요.

   
   
9. XML, JSON, X-FORM-URLENCODED 중에서 인코딩을 선택하세요. 선택에 따라 고급 자동화 앱은 콘텐츠 본문을 검증합니다. 예를 들어 JSON을 선택하면 콘텐츠 본문이 유효한 JSON 형식이어야 하며, 그렇지 않으면 오류 메시지가 표시됩니다.
   
   
10. 완료되면 완료를 클릭하세요.
    
    

API 트리거를 사용한 자동화 설정

1. 자동화 화면에서 새 자동화를 생성하거나 기존 자동화를 편집하세요.
   
   
2. 필요한 트리거와 조건을 설정하세요.
   
   
3. 작업 화면에서 "API 트리거"를 선택하면 고급 자동화 앱이 API 라이브러리의 API 목록을 보여줍니다.
   
   

예시

예시를 통해 자세히 살펴보겠습니다. 이 예시에서는 이미 두 개의 API를 설정했습니다.

• 첫 번째 API는 Freshdesk에서 티켓을 생성하고, 두 번째 API는 동일한 Freshdesk 티켓에 답장을 추가합니다.
  
  
• 두 번째 API는 모델 이름을 사용하여 첫 번째 API의 응답의 일부인 티켓 ID를 사용합니다.
  
  
• freshdesk_ticket API 설정은 이 문서에서 앞서 설명한 것과 동일합니다. 두 번째 API를 설정할 때는 첫 번째 API의 모델 이름을 참조해야 합니다. 

두 번째 API는 Freshdesk에서 티켓이 생성될 때 응답 객체의 일부인 티켓 ID를 조회하기 위해 URL 필드를 사용합니다.

예를 들어, 티켓 생성 API를 사용할 때 Freshdesk는 응답 객체에 다음 속성을 제공합니다:

{
  "cc_emails" : ["ram@freshdesk.com", "diana@freshdesk.com"],
  "fwd_emails" : [ ],
  "reply_cc_emails" : ["ram@freshdesk.com", "diana@freshdesk.com"],
  "email_config_id" : null,
  "group_id" : null,
  "priority" : 1,
  "requester_id" : 129,
  "responder_id" : null,
  "source" : 2,
  "status" : 2,
  "subject" : "지원 필요..",
  "company_id" : 1,
  "id" : 1,
  "type" : "질문",
  "to_emails" : null,
  "product_id" : null,
  "fr_escalated" : false,
  "spam" : false,
  "urgent" : false,
  "is_escalated" : false,
  "created_at" : "2015-07-09T13:08:06Z",
  "updated_at" : "2015-07-23T04:41:12Z",
  "due_by" : "2015-07-14T13:08:06Z",
  "fr_due_by" : "2015-07-10T13:08:06Z",
  "description_text" : "문제에 대한 세부 정보 ...",
  "description" : "<div>문제에 대한 세부 정보 ..</div>",
  "tags" : [ ],
  "attachments" : [ ]
}