외부 API 요청

외부 API 요청을 사용하면 요청 템플릿을 정의한 다음 비즈니스 프로세스 내에서 API로 나가는 호출을 트리거할 수 있습니다. 이를 통해 시장에 아직 모듈이 존재하지 않더라도 프로젝트를 타사 서비스에 연결할 수 있습니다.

정의

연결하려는 서비스 공급자의 API 설명서에서 요청을 구성하는 방법에 대한 사양을 참조하십시오.

1. 새 요청 템플릿을 정의하려면 사이드바의 "비즈니스 논리" 탭(1)으로 이동하고 "외부 API 요청" 탭(2)으로 전환한 다음 "새 API 요청"(3)을 클릭합니다.

2. 새 요청에 이름을 지정하고 선택적으로 설명을 지정합니다.

3. 요청 HTTP 메서드와 해당 URL을 선택합니다.

4. 매개변수 이름(1), 유형(2)을 입력하고 "매개변수 추가"(3)를 클릭하여 URL 매개변수, 쿼리 매개변수(GET 요청에만 해당), 헤더 및 요청 본문을 정의합니다.

이러한 매개변수의 실제 값은 요청이 트리거되는 비즈니스 프로세스 실행 시 정의됩니다.

URL과 쿼리 매개변수의 차이점을 이해하려면 여기에서 자세히 읽어보세요. 표준에 관계없이 연결하려는 서비스 공급자의 API 문서는 요청을 구축하는 방법에 대한 최상의 정보 소스입니다.

또한 샘플 JSON을 입력하여 요청 헤더와 본문을 자동으로 채울 수 있으며, 시스템은 필요한 모든 매개변수를 자동으로 생성합니다.

모든 탭에 새 매개변수를 추가할 필요는 없습니다. 예를 들어 일부 요청에는 URL 매개변수, 헤더 또는 본문이 전혀 포함되지 않을 수 있습니다.

요청에 개체가 포함된 경우(예: 자동차 -> 색상, 크기 등) 나중에 비즈니스 프로세스에서 이러한 개체를 처리하기 위해 가상 모델을 만들어야 합니다. 매개변수 유형 선택기에서 "모델"을 선택하고 필요한 하위 요소를 도입하면 됩니다. 필요한 만큼 개체를 중첩하고(예: 개체 내 개체) 가상 모델 배열을 만들 수 있습니다. 자동 채우기를 사용한 경우 이 프로세스가 자동으로 완료됩니다.

5. "설정" 탭에서 SSL 확인, 시간 초과 및 오류 처리와 같은 요청 설정을 변경합니다.

6. "테스트 요청"을 클릭하고 필요한 모든 매개변수를 입력하여 요청을 테스트합니다. 서버의 응답을 확인하고 응답 헤더와 본문을 자동으로 채우거나 수동으로 채웁니다.

7. "요청 저장"을 클릭하여 요청 템플릿을 저장합니다.

사용

새 요청을 정의하고 저장하면 비즈니스 프로세스 편집기에서 새 블록을 사용하여 트리거할 수 있습니다.

이러한 블록을 사용하여 만들 수 있는 데이터 모델로 요청에 추가하려는 모든 구성 요소(URL 및 쿼리 매개 변수, 헤더 및 본문)를 제공해야 합니다. 출력에서 형식이 지정된 응답 본문, 헤더 및 응답 상태를 추출할 수 있습니다. 이러한 블록을 사용하여 이러한 모델을 확장할 수 있습니다.

요청을 올바르게 트리거하기 위해 모든 데이터 입력을 연결할 필요는 없습니다. 예를 들어 URL 매개변수가 없는 요청이 있는 경우 해당 모델을 생성하고 연결할 필요가 없습니다.

정의한 모든 가상 모델에 대해 2개의 새로운 블록이 Business Process Editor에 추가되어 이를 만들고 확장합니다.

모니터링

API 요청을 트리거할 때마다 시스템은 유형 및 주소, 요청 본문, 응답 HTTP 상태 코드 및 응답 본문을 로그에 출력합니다. 응답 본문의 특정 필드 또는 로그에 쓰기 블록을 사용하여 로그에 대한 대기 시간과 같은 기타 정보를 출력할 수 있습니다.