RESTful API

쿼리 추가

페이지 목록에서 워크플로우를 추가하여 쿼리 스텝을 추가할 수 있습니다.
워크플로우 스텝 사이드바에서 RESTful API 데이터 소스를 선택하면 쿼리 입력 창이 나타납니다.
데이터 소스 추가 방법은 RESTful API 데이터 소스 가이드를 참고해주세요.

rest-api

동적 URL 사용하기

경로 변수를 템플릿으로 사용하여 동적 URL을 구성할 수 있습니다.

{{ /users/{id} }} 경로에서 {id} 부분을 URL 값으로 대체
{{ /organizations/{orgId}/teams/{teamId} }} 처럼 여러 변수도 사용 가능

본문 타입

다음 형식 중 하나를 선택하여 데이터를 전송할 수 있습니다.

Text: 일반 텍스트 형식
Form: application/x-www-form-urlencoded 형식
Form(Multipart): multipart/form-data 형식 (파일 업로드 시 사용)
JSON: application/json 형식

사용 가능한 메서드

GET 요청

GET 요청은 서버에서 데이터를 가져오는 가장 기본적인 방법입니다. GET 요청은 다음과 같은 방식으로 사용할 수 있습니다.

API 엔드포인트 URL을 경로에 입력합니다
필요한 경우 URL 값과 쿼리 파라미터를 설정합니다
헤더와 쿠키를 통해 인증 정보를 전달합니다

일반적으로 GET 요청에서는 본문을 사용하지 않지만, 필요한 경우 본문을 포함하여 요청을 보낼 수 있습니다.

rest-api-get

이름	타입	설명
경로 (path)	`string`	API 엔드포인트 경로
URL 값 (params)	`object`	URL 경로 변수
본문 타입	`enum`	None, Text, Form, Form(Multipart), JSON 중 선택
본문 (body)	`unknown`	요청 본문 데이터 (선택한 본문 타입에 따라 다른 형식으로 전송됨)
헤더 (headers)	`object`	HTTP 요청 헤더
쿠키 (cookies)	`object`	HTTP 쿠키

POST 요청

POST 요청은 새로운 리소스를 생성하기 위한 요청으로 다음과 같은 방식으로 사용할 수 있습니다.

API 엔드포인트 URL을 경로에 입력합니다
생성할 리소스의 데이터를 요청 본문에 포함합니다
필요한 경우 URL 값을 통해 경로 변수를 설정합니다
본문 타입을 선택하여 데이터 형식을 지정합니다
헤더와 쿠키를 통해 인증 정보를 전달합니다

rest-api-post

이름	타입	설명
경로 (path)	`string`	API 엔드포인트 경로
URL 값 (params)	`object`	URL 경로 변수
본문 타입	`enum`	None, Text, Form, Form(Multipart), JSON 중 선택
본문 (body)	`unknown`	요청 본문 데이터 (선택한 본문 타입에 따라 다른 형식으로 전송됨)
헤더 (headers)	`object`	HTTP 요청 헤더
쿠키 (cookies)	`object`	HTTP 쿠키

PUT 요청

PUT 리소스를 업데이트 하기 위한 요청으로 다음과 같은 방식으로 사용할 수 있습니다.

API 엔드포인트 URL을 경로에 입력합니다
업데이트할 리소스의 전체 데이터를 요청 본문에 포함합니다
필요한 경우 URL 값을 통해 경로 변수를 설정합니다
본문 타입을 선택하여 데이터 형식을 지정합니다
헤더와 쿠키를 통해 인증 정보를 전달합니다

rest-api-put

이름	타입	설명
경로 (path)	`string`	API 엔드포인트 경로
URL 값 (params)	`object`	URL 경로 변수
본문 타입	`enum`	None, Text, Form, Form(Multipart), JSON 중 선택
본문 (body)	`unknown`	요청 본문 데이터 (선택한 본문 타입에 따라 다른 형식으로 전송됨)
헤더 (headers)	`object`	HTTP 요청 헤더
쿠키 (cookies)	`object`	HTTP 쿠키

DELETE 요청

DELETE 요청은 리소스를 삭제하기 위한 요청으로 다음과 같은 방식으로 사용할 수 있습니다.

API 엔드포인트 URL을 경로에 입력합니다
삭제할 리소스의 식별자를 URL에 포함합니다
필요한 경우 URL 값을 통해 경로 변수를 설정합니다
헤더와 쿠키를 통해 인증 정보를 전달합니다

rest-api-delete

이름	타입	설명
경로 (path)	`string`	API 엔드포인트 경로
URL 값 (params)	`object`	URL 경로 변수
본문 타입	`enum`	None, Text, Form, Form(Multipart), JSON 중 선택
본문 (body)	`unknown`	요청 본문 데이터 (선택한 본문 타입에 따라 다른 형식으로 전송됨)
헤더 (headers)	`object`	HTTP 요청 헤더
쿠키 (cookies)	`object`	HTTP 쿠키

PATCH 요청

PATCH 요청은 리소스를 부분적으로 수정하기 위한 요청으로 다음과 같은 방식으로 사용할 수 있습니다.

API 엔드포인트 URL을 경로에 입력합니다
수정할 리소스의 식별자를 URL에 포함합니다
필요한 경우 URL 값을 통해 경로 변수를 설정합니다
본문 타입을 선택하고 수정할 데이터를 본문에 포함합니다
헤더와 쿠키를 통해 인증 정보를 전달합니다

rest-api-patch

이름	타입	설명
경로 (path)	`string`	API 엔드포인트 경로
URL 값 (params)	`object`	URL 경로 변수
본문 타입	`enum`	None, Text, Form, Form(Multipart), JSON 중 선택
본문 (body)	`unknown`	요청 본문 데이터 (선택한 본문 타입에 따라 다른 형식으로 전송됨)
헤더 (headers)	`object`	HTTP 요청 헤더
쿠키 (cookies)	`object`	HTTP 쿠키

쿼리 결과값

REST API 쿼리를 실행하면 API 제공자가 정의한 형식 그대로 응답이 반환됩니다. 각 API마다 고유한 응답 구조와 데이터 형식을 가지고 있으므로, API 문서를 참고하여 응답 형식을 확인해주세요.

결과값 활용하기

// 결과값 예시
{
  status: 200,
  statusText: 'OK',
  data: {
    id: 123,
    name: '강홉스',
    email: 'hops@example.com',
    createdAt: '2024-01-01T00:00:00Z'
  },
  headers: {
    'content-type': 'application/json',
    'x-request-id': 'abc123'
  }
}

// 결과값 활용하기
return outputs.data.name;

RESTful API

쿼리 추가​

동적 URL 사용하기​

본문 타입​

사용 가능한 메서드​

GET 요청​

POST 요청​

PUT 요청​

DELETE 요청​

PATCH 요청​

쿼리 결과값​

결과값 활용하기​