ProtoPie Connect에서 API 플러그인 사용하기
API 플러그인을 사용하면 프로토타입을 API 및 데이터베이스에 연결하여 실제 데이터를 빠르게 가져올 수 있습니다.
사용자 정의 플러그인(Custom Plugins)과 달리 API 플러그인은 코딩 기술이 필요하지 않습니다. 이 플러그인은 API로 데이터를 전송하거나 API에서 데이터를 검색하여 프로토타입에 JSON 형식으로 원활하게 통합하는 작업을 처리합니다.
API란 무엇인가요?
API(응용 프로그램 프로그래밍 인터페이스)는 서로 다른 컴퓨터 프로그램이 서로 통신하고 함께 작동할 수 있도록 해주는 규칙 모음입니다. 각 프로그램이 작동하는 모든 세부 사항을 알지 못해도 정보를 공유하고 작업을 수행하도록 돕는 다리와 같습니다. 더 쉽게 말해, API를 통해 소프트웨어가 더 쉽게 통신하고 협업할 수 있습니다.
지원되는 API 유형
API 플러그인을 사용하면 GET이든 POST든 API 요청을 쉽게 시작할 수 있으며 다양한 API 유형과 연결할 수 있습니다.
공개 API(Public APIs): Spotify, OpenWeatherMap, YouTube, ChatGPT, 라이브 스코어 등과 같은 인기 요소를 포함합니다.
내부 API(Internal APIs): 조직의 시스템 및 서비스와 원활하게 연결됩니다.
API 요청 방법
ProtoPie Connect에서 API 플러그인을 사용하고 프로토타입에서 API 요청을 수행하려면 다음의 쉬운 단계를 따르세요.
단계 1: ProtoPie Studio에서 Send 반응 만들기
먼저 ProtoPie Studio에서 선택한 트리거에 Send 반응을 추가합니다.
일반적으로 ProtoPie Studio와 ProtoPie Connect 간에 정보를 주고받을 때 설정하는 것처럼
ProtoPie Connect/Studio채널을 선택하는 것을 잊지 마세요.프로토타입을 저장합니다.
이 프로토타입 예시에서는 토글 스위치를 사용하여 "Random Fact"를 선택할 때 Useless Facts API의 데이터를 가져오려고 합니다. 이를 위해, 우리는 ProtoPie Connect/Studio 채널과 고유한 메시지 값을 가진 Send 반응을 만드는 것부터 시작합니다.
팁: ProtoPie School에서 이 무료 강의를 시청하여 ProtoPie Studio와 ProtoPie Connect 간의 Send 및 Receive 메시지를 마스터해 보세요.
단계 2: API 플러그인 내에서 API 설정 구성하기
ProtoPie Connect에서 프로토타입을 엽니다.
Plugin을 클릭한 다음 목록에서API플러그인을 선택합니다.사용 가능한 두 가지 HTTP 요청 방법인 GET 또는 POST 중 하나를 선택합니다. API 요청 시 GET은 API 제공자로부터 데이터를 검색하고, POST는 프로세스를 처리할 새 데이터를 보냅니다.
액세스하려는 API의 정확한 API URL을 입력합니다. 정확한 URL을 얻으려면 API의 온라인 문서를 참조하세요. 예시에서 필요한 URL은 이 페이지에서 볼 수 있듯이
https://uselessfacts.jsph.pl/api/v2/facts/random입니다.API에서 필요로 하는 경우
Header와Body를 포함시킵니다. API URL 외에 필요한 추가 매개변수가 있는지 선택한 API의 문서를 주의 깊게 읽어보세요.Header는 JSON {} 형식이어야 하지만,Body가 항상 JSON {} 형식을 따를 필요는 없습니다. API에서 요구하는 경우Body를 JSON {} 형식으로 입력할 수 있습니다.Test Request버튼을 클릭하여 연결이 제대로 작동하는지 확인합니다. 오류 메시지가 나타나면 이전 단계에서 입력한 정보를 검토하세요.
단계 3: API를 프로토타입에 연결하기
Message From Pie입력 필드를 클릭하여 사용 가능한 메시지 목록에 액세스합니다. API 플러그인은 프로토타입 내의 메시지를 자동으로 감지합니다. 메시지가 표기되지 않으면 단계 1에서 생성한 Send 반응에서 복사하여 붙여넣으세요.프로토타입에서 전송된 메시지 값으로 API의 URL, Header 또는 Body를 동적으로 재정의해야 하는 경우
Override URL/Header/Body with msg value를 활성화합니다. 메시지 값으로 API URL/Header/Body 재정의에 대해 자세히 알아보세요.Message to Pie에 메시지를 입력하면, 단계 2에서 구성한 API 요청에서 얻은 데이터와 함께 해당 메시지가 프로토타입으로 다시 전송됩니다.Activate를 클릭하여 연결을 설정합니다. 플러그인은 프로토타입으로부터 상응하는 메시지를 수신하는 즉시 API 요청을 재개합니다.
단계 4: ProtoPie Studio에서 Receive 트리거 생성하기
ProtoPie Studio로 돌아갑니다.
프로토타입에 Receive 트리거를 추가합니다.
단계 1에서 Send 반응을 설정한 것처럼
ProtoPie Connect/Studio채널을 선택해야 합니다.단계 3의
Message to Pie아래에 구성한 것과 동일한 메시지를 입력합니다.Assign to Variable옵션을 활성화합니다. 텍스트 변수를 생성하고 Receive 트리거의 목록에서 선택합니다. 이제 API에서 얻은 정보가 이 변수 내에 저장됩니다.API 데이터는 대개 JSON 형식으로 반환되므로, Text 반응과 parseJson 공식을 활용하는 것이 API 데이터를 프로토타입에 통합하는 가장 효율적인 방법입니다.
프로토타입을 저장한 다음 ProtoPie Connect에서 다시 로드하세요. 이제 API가 적용된 인터랙션을 ProtoPie Connect에서 테스트할 준비가 되었습니다!
메시지 값으로 API URL/Header/Body 재정의하기
Override URL/Header/Body with msg value 기능은 프로토타입에서 보낸 메시지 값으로 API의 URL, Header, Body 매개변수를 동적으로 재정의하는 데 사용됩니다.
이 프로토타입 예시에서는 이 기능을 사용하여 API URL을 Pie 파일에 있는 아래 Send 메시지의 값으로 재정의했습니다. 결과적으로, ProtoPie Connect에서 프로토타입을 테스트하고 검색창에 도시 이름을 입력하면 해당 도시의 정확한 날씨 정보를 확인할 수 있습니다.
API 동시 호출 실행하기
Connect Core 및 Connect Enterprise 사용자는 API 플러그인을 사용하여 동시에 여러 API 요청을 실행할 수 있습니다. Connect Core는 최대 3개의 API를 동시에 실행할 수 있는 역량을 갖추고 있으며(다른 플러그인이 실행되고 있지 않은 경우), Connect Enterprise는 동시에 호출할 수 있는 API 요청 수에 제한이 없습니다.
프로토타입에서 동시에 여러 API 요청을 실행하려면 다음 단계를 수행하세요.
ProtoPie Connect에서 API 플러그인을 엽니다.
API 설정 창의 오른쪽 상단에 위치한
+아이콘을 클릭합니다. 새 창이 열리면 여기에서 추가 API 호출을 구성하고 동시에 실행할 수 있습니다. 기존 API를 복제하여 기존의 원래 설정을 유지할 수도 있습니다.
API 플러그인 사용 가이드 튜토리얼
이 사용 가이드 시리즈에서 API 플러그인의 주요 기능과 활용 사례를 살펴보세요.