REST 연결 구성
type: rest는 허용한 도메인의 외부 REST 시스템에 연결합니다. domains는 최소 한 개의 항목이 필요합니다. 인증을 설정한 도메인은 HTTPS를 사용해야 하며, 인증을 생략한 도메인은 인증 없이 접근합니다.
OAuth2를 사용하려면 Control Panel의 조직 설정에 외부 인증 애플리케이션을 구성하고 그 RID를 oauth2ClientRid에 넣습니다. 한 연결에서 사용할 수 있는 외부 인증 애플리케이션은 하나입니다. 연결과 인증의 관계는 Data Connection 핵심 개념에서 확인할 수 있습니다.
생성 입력의 필드
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
type | enum | 필수 | 분기를 구분하는 type 값입니다. 허용값: rest. | rest |
additionalSecrets | RestConnectionAdditionalSecrets | 선택 | 코드와 웹훅 구성에서 참조할 추가 비밀입니다. 생략하면 추가 비밀을 만들지 않습니다. | |
oauth2ClientRid | string | 선택 | 외부 시스템에 OAuth2로 인증할 외부 인증 애플리케이션의 RID입니다. 한 연결에서는 OAuth2용 애플리케이션 하나만 사용할 수 있습니다. 다른 애플리케이션을 선택하면 OAuth2를 사용하는 모든 도메인의 구성이 바뀝니다. | |
domains | list<Domain> | 선택 | 연결이 접근할 수 있는 도메인 목록입니다. 최소 한 개의 도메인이 필요합니다. |
additionalSecrets의 구조
분기 asSecretsWithPlaintextValues
비밀 이름과 평문 값을 대응시키는 맵입니다. REST 연결의 추가 비밀을 만들거나 갱신할 때 사용합니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
type | enum | 필수 | 분기를 구분하는 type 값입니다. 허용값: asSecretsWithPlaintextValues. | asSecretsWithPlaintextValues |
secrets | map<SecretName, PlaintextValue> | 선택 | 코드와 웹훅 구성에서 참조할 추가 비밀의 이름과 값입니다. |
secrets의 구조
맵의 키는 SecretName(string), 값은 PlaintextValue(string)입니다.
분기 asSecretsNames
코드와 웹훅 구성에서 참조할 비밀 이름 목록입니다. REST 연결 구성을 조회할 때 이 형태를 반환합니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
type | enum | 필수 | 분기를 구분하는 type 값입니다. 허용값: asSecretsNames. | asSecretsNames |
secretNames | list<SecretName> | 선택 | 코드와 웹훅 구성에서 참조할 추가 비밀의 이름 목록입니다. |
secretNames의 구조
배열 항목은 SecretName이며 자료형은 string입니다.
domains의 구조
배열 항목은 Domain이며 자료형은 object입니다.
연결이 접근할 수 있는 도메인입니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
scheme | enum | 선택 | 접근할 도메인의 스킴입니다. 생략하면 HTTPS를 사용합니다. 허용값: HTTP, HTTPS. | HTTP |
host | string | 필수 | 도메인 이름, IPv4 또는 IPv6 주소입니다. | my-rest-api.com |
port | integer | 선택 | 접근할 도메인의 포트 번호입니다. | 443 |
auth | RestAuthenticationMode | 선택 | 인증을 사용하는 경우 URI 스킴은 HTTPS여야 합니다. 이 필드를 생략하면 인증을 사용하지 않습니다. |
auth의 구조
분기 bearerToken
외부 시스템 인증에 사용하는 Bearer 토큰입니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
type | enum | 필수 | 분기를 구분하는 type 값입니다. 허용값: bearerToken. | bearerToken |
bearerToken | EncryptedProperty | 필수 | 조회 시에는 암호화된 값 대신 비밀 이름을 반환합니다. 쓸 때 평문 값을 전달하면 암호화하여 저장합니다. 비밀 이름을 전달하면 해당 속성의 기존 비밀 이름과 같아야 하며 기존 암호화 값을 유지합니다. |
bearerToken의 구조
입력과 조회에서 사용하는 값의 차이 및 두 분기의 전체 구조는 암호화 속성을 따릅니다.
분기 apiKey
외부 시스템 인증에 사용하는 API 키입니다. 헤더 또는 쿼리 매개변수에 넣도록 구성할 수 있습니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
type | enum | 필수 | 분기를 구분하는 type 값입니다. 허용값: apiKey. | apiKey |
location | RestRequestApiKeyLocation | 필수 | 요청에서 API 키를 전달할 위치입니다. | |
apiKey | EncryptedProperty | 필수 | API 키의 값입니다. |
location의 구조
분기 header
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
type | enum | 필수 | 분기를 구분하는 type 값입니다. 허용값: header. | header |
headerName | string | 필수 | API 키를 전달할 헤더 이름입니다. | X-API-KEY |
분기 queryParameter
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
type | enum | 필수 | 분기를 구분하는 type 값입니다. 허용값: queryParameter. | queryParameter |
queryParameterName | string | 필수 | API 키를 전달할 쿼리 매개변수 이름입니다. | api_key |
apiKey의 구조
입력과 조회에서 사용하는 값의 차이 및 두 분기의 전체 구조는 암호화 속성을 따릅니다.
분기 basic
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
type | enum | 필수 | 분기를 구분하는 type 값입니다. 허용값: basic. | basic |
username | string | 필수 | ||
password | EncryptedProperty | 필수 | 조회 시에는 암호화된 값 대신 비밀 이름을 반환합니다. 쓸 때 평문 값을 전달하면 암호화하여 저장합니다. 비밀 이름을 전달하면 해당 속성의 기존 비밀 이름과 같아야 하며 기존 암호화 값을 유지합니다. |
password의 구조
입력과 조회에서 사용하는 값의 차이 및 두 분기의 전체 구조는 암호화 속성을 따릅니다.
분기 oauth2
Control Panel의 조직 설정에 외부 인증 애플리케이션을 먼저 구성해야 합니다. 그 RID를 REST 연결 구성의 oauth2ClientRid에 지정합니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
type | enum | 필수 | 분기를 구분하는 type 값입니다. 허용값: oauth2. | oauth2 |
추가 비밀의 입력과 조회
additionalSecrets.type: asSecretsWithPlaintextValues는 비밀 이름과 평문 값의 맵을 입력하는 형태입니다. 조회한 구성에는 asSecretsNames와 이름 목록이 반환됩니다. 기존 비밀값만 바꾸려면 Update Secrets For Connection에 현재 연결의 비밀 이름을 전달합니다.
도메인별 API 키는 location.type: header와 headerName, 또는 location.type: queryParameter와 queryParameterName으로 위치를 선택합니다. Bearer 토큰, API 키 및 비밀번호 값은 암호화 속성을 사용합니다.