API용 플로우 만들기(1부)

API의 플로우에는 요청, 하나 이상의 대상 애플리케이션 작업, API 작업에 대한 응답이 포함됩니다. 플로우는 모바일 및 웹 애플리케이션 등에서 API 작업을 호출하여 트리거됩니다.

개발자가 애플리케이션의 데이터를 사용하는 앱을 만들 수 있도록 하려면 API를 제공하면 됩니다. 예를 들어 CRM 시스템에서 고객을 생성, 검색 및 업데이트할 수 있는 API를 제공할 수 있습니다. API를 정의하려면 다음과 같은 높은 수준의 단계를 완료합니다.
  1. 만들거나 검색하려는 개체의 구조를 정의하는 모델을 하나 이상 만듭니다.
  2. 각 모델에 대해 완료할 생성, 검색 또는 업데이트 작업을 선택합니다.
  3. 각 작업을 구현하는 흐름을 구성하여 데이터를 보유하는 하나 이상의 대상 애플리케이션을 추가합니다.

다음 단계에서는 API에 대한 플로우를 만드는 방법을 자세히 설명합니다 App Connect 를 사용하여 Salesforce 연락처를 만드는 방법을 자세히 설명합니다.

필요한 모든 것을 찾거나 생성하세요

  • 계정에 아직 연결되지 않은 경우 Salesforce 계정에 아직 연결되지 않은 경우 계정의 이름과 비밀번호를 Salesforce 계정을 입력합니다.
    참고: 무료로 테스트 계정을 만들려면 Salesforce 에서 무료로 테스트 계정을 만들려면 비즈니스 계정을 사용하는 대신 URL https://developer.salesforce.com 에서 평가판 계정 대신 개발자 계정을 등록하세요. 에 연결하면 App Connect 평가판 계정으로 연결하면 Salesforce 이벤트가 작동하지 않습니다.

API에 대한 플로우 만들기

  1. 디자이너 대시보드에서 만들기 > API에 대한 플로우를 클릭합니다.
  2. API의 목적을 식별할 수 있는 이름을 입력합니다(예: Customer API).
    그림 1. API를 식별할 수 있는 이름을 입력합니다
    API를 식별할 수 있는 이름을 입력합니다
  3. 모델 이름 필드에 API가 작동하는 객체 유형을 반영하는 모델 이름을 입력합니다.

    빌드 중인 API 흐름은 고객을 Salesforce. 따라서 모델 이름 필드에 Customer 을 입력합니다.

  4. 모델 생성을 클릭합니다. 고객 모델 패널에는 속성 탭과 작업 탭이 열립니다.
  5. 속성 탭에서 API가 작동하는 객체의 구조를 정의하는 속성을 추가합니다.
    1. API가 고객을 생성, 업데이트 및 검색하기를 원합니다. 따라서 고객을 식별하는 다음 속성을 고객 모델에 추가합니다. 각 속성의 기본 유형은 String 입니다.
      CustomerID
      FirstName
      LastName
      Email
      그림 2. API에 대한 속성 추가하기.
      API에 대한 속성 추가하기.
      유효한 속성 이름에는 다음과 같은 특징이 있습니다:
      • 각 속성 이름은 고유해야 합니다.
      • 속성 이름에는 공백을 포함할 수 없지만 밑줄 문자(_)를 사용하여 단어를 구분할 수 있습니다.
      • 이름에는 문자, 숫자 또는 밑줄 문자만 포함해야 합니다.
      • 이름은 2자 이상이어야 합니다.
      • 이름은 문자 또는 밑줄로 시작해야 합니다.
      팁: 속성 이름을 입력하거나 애플리케이션에서 속성 선택을 클릭하여 연결된 하나 이상의 애플리케이션에서 속성을 선택합니다.
    2. 기본적으로 처음 추가하는 속성(CustomerID)이 ID 속성으로 선택됩니다. 고객 개체를 만들 때 흐름에서 고객 ID를 반환하도록 하려면 이 속성을 ID 속성으로 남겨둡니다.
      참고: 흐름에서 개체를 생성할 때 ID 속성을 반환해야 합니다. 또는 ID 속성을 사용하여 객체를 업데이트하거나 검색하려면 요청에서 ID 속성을 보내야 합니다. ID 속성으로 하나의 속성만 설정할 수 있습니다.

      모델 만들기를 클릭하여 더 많은 모델을 만들 수 있습니다. 모델을 삭제하려면 메뉴에서 모델 삭제를 선택합니다.

  6. API가 개체와 상호 작용하는 방식을 정의하려면 작업을 클릭합니다. 작업 탭에서 다음 작업을 정의할 수 있습니다.
    • 오브젝트를 작성합니다.
    • 고유 ID를 사용하거나 필터를 사용하여 개체를 검색합니다.
    • ID 또는 필터를 사용하여 개체를 바꾸거나 새로 만듭니다. 이 작업은 개체가 있는 경우 개체를 대체하고, 없는 경우 개체를 생성합니다.
    참고: 사용자 지정 작업 추가를 클릭하여 직접 작업을 정의할 수도 있습니다. 사용자 지정 작업에는 다음과 같은 제한 사항이 있습니다:
    • 작업 이름은 다음 키워드 중 하나 일 수 없습니다: create, updateOrCreate, all, updateAttributes, update, updateAll, upsertWithWhere, replaceOrCreate, replaceById, destroy, destroyAll, executeAssembly.
    • 쿼리 매개변수는 모델 ID와 동일할 수 없습니다.

    자세한 내용은 API 흐름에서 사용자 지정 HTTP 작업 만들기를 참조하세요

    1. 고객 생성을 선택합니다.
      그림 3. Create Customer 작업 추가
      고객 생성 작업 선택
  7. Create Customer 작업의 작동 방식을 정의하는 플로우를 만들려면 플로우 구현을 클릭합니다. 흐름 편집기에는 요청 노드, 응답 노드 및 하나 이상의 대상 애플리케이션을 추가할 수 있는 노드 추가 아이콘( 흐름에 노드를 추가하는 아이콘 )이 있는 기본 흐름이 표시됩니다. 모델의 프로퍼티와 몇 가지 샘플 데이터로 구성된 요청 본문 예제의 구조를 살펴보세요.
    그림 4. 몇 가지 샘플 데이터가 포함된 고객 모델의 요청 본문 예시
    고객 모델의 요청 본문 예시(샘플 데이터 포함)
  8. 플로우에 대상 애플리케이션을 추가하려면 노드 추가 (+)를 클릭합니다.
  9. Salesforce > 연락처 > 연락처 만들기를 선택합니다.

    만약 App Connect 에 아직 연결되지 않은 경우 Salesforce연결되지 않은 경우 연결을 클릭하고 Salesforce 계정의 세부 정보를 입력합니다. 자세한 내용은 App Connect 와 Salesforce 의 사용 방법을 참조하세요.

  10. 요청의 필드를 다음과 같이 Salesforce 연락처 만들기 작업으로 매핑합니다.
    • 계정 ID를 클릭하고 매핑 삽입 매핑 아이콘 삽입 을 클릭한 다음 사용 가능한 입력 목록에서 CustomerID 을 선택합니다.
    • 성에 last 을 입력한 다음 목록에서 LastName 을 선택합니다.
    • 이름에 fir 을 입력한 다음 목록에서 FirstName 을 선택합니다.
    • 이메일에 em 을 입력한 다음 목록에서 Email 을 선택합니다.
    그림 5. 요청의 필드를 Salesforce 연락처 만들기 작업으로 매핑합니다
    Salesforce 액션에 대한 매핑된 필드
  11. 흐름에 조건부 논리를 추가할 수도 있습니다. 예를 들어, 흐름이 조건에 따라 다른 작업을 수행하도록 하려면 하나 이상의 If 노드를 흐름에 추가하면 됩니다. 자세한 내용은 흐름에 조건부 논리 추가하기를 참조하세요.
  12. 흐름에서 응답 노드를 클릭하여 작업이 성공적으로 완료될 때 반환되는 응답을 정의합니다. 사용 가능한 필드를 Salesforce 연락처 만들기 작업의 사용 가능한 필드를 다음과 같이 응답에 매핑합니다.
    • 필수 응답 필드 CustomerID의 경우 매핑합니다 Salesforce 필드에 매핑합니다 Contact ID. 필요한 경우 다른 필드를 매핑하여 응답에 해당 값을 반환합니다.
      그림 6. 에서 사용 가능한 필드를 Salesforce 연락처 작업 만들기에서 응답에 매핑
      API 응답 노드 매핑
      참고: 응답 헤더 섹션에서 고유한 응답 코드 매핑을 선택할 수 있습니다. 다양한 작업에 대해 다음과 같은 응답 코드가 반환됩니다:
      • 만들기 작업은 응답 코드 201(레코드가 생성됨)을 반환합니다.
      • 검색 작업은 응답 코드 200(레코드 검색됨)을 반환합니다.
      • 바꾸기 또는 만들기 작업은 응답 코드 200(레코드가 교체됨) 또는 201(레코드가 생성됨)을 반환합니다.
  13. 완료를 클릭하여 모델로 돌아갑니다.

결론

API를 만들었습니다. API 테스트를 클릭하여 API를 테스트할 수 있습니다. 자세한 내용은 개발 중 흐름 테스트를 참조하세요. 다른 플로우와 동일한 방식으로 App Connect 디자이너 대시보드에서 API 플로우를 시작 및 중지할 수 있습니다. API가 실행 중일 때는 열 수 있지만 편집하려면 먼저 중지해야 합니다.

그림 7. App Connect 디자이너 대시보드의 흐름 타일
실행 중인 API 흐름의 타일입니다.

동일한 API를 사용하여 연락처를 검색하고 업데이트하는 방법을 알아보려면 Salesforce 연락처를 검색하고 업데이트하는 방법을 알아보려면 API에 대한 플로우 만들기(2부)를 참조하세요.