프로토파이 커넥트에서 API 플러그인 사용하기

API 플러그인을 사용하면 실제 데이터를 API 및 데이터베이스에 연결하여 신속하게 프로토타입으로 가져올 수 있습니다. 사용자 지정 플러그인과는 달리 (custom plugins) API 플러그인의 사용에는 코딩 기술이 필요하지 않습니다. 이 플러그인은 데이터를 API에 보내는 작업이나 데이터를 API에서 검색하여 JSON 형식으로 프로토타입에 원활하게 통합하는 작업에 관여합니다.

API란 무엇인가요?

API(Application Programming Interface: 애플리케이션 프로그래밍 인터페이스)는 서로 다른 컴퓨터 프로그램이 통신하고 함께 작동할 수 있게 해주는 규칙 집합입니다. 이것은 각각의 프로그램이 작동하는 방식의 모든 세부 정보를 알지 못해도 정보를 공유하고 작업할 수 있게 해주는 교량의 역할을 합니다. 즉, API를 사용하면 소프트웨어가 통신하고 협업하는 것이 더 쉬워집니다.

지원되는 API 유형

API 플러그인을 사용하면 GET이든 POST든 API 요청을 빠르게 시작하고 다양한 API 유형과 연결할 수 있습니다.

공개 API: 이것은 스포티파이, 오픈웨더맵, 유튜브, 챗GPT, 라이브스코어 등같이 인기 있는 서비스를 포함합니다.
내부 API: 조직의 시스템 및 서비스와 원활하게 연결할 수 있습니다.

API 요청을 만드는 방법

프로토파이 커넥트에서 API 플러그인을 사용하고 프로토타입에서 API 요청을 만들려면 다음과 같은 단계를 간단히 따르세요.

1단계: 프로토파이 스튜디오에서 보내기(Send) 응답 만들기

프로토파이 스튜디오에서 Send (보내기) 응답을 선택한 트리거에 추가하여 시작합니다.
프로토파이 스튜디오 및 프로토파이 커넥트 간에 정보를 주고 받을 때 일반적으로 하는 것처럼 ProtoPie Connect/Studio 채널을 선택하는 것을 잊지 마세요.
프로토타입을 저장합니다.

이 프로토타입 예시에서는 토글 스위치를 사용하여 "Random Fact"를 선택할 때 Useless Facts API에서 데이터를 가져오려고 합니다. 이 작업을 수행하기 위해 ProtoPie Connect/Studio 채널 및 고유 메시지 값을 사용하여 보내기(Send) 응답을 만듭니다.

Tip: 프로토파이 스튜디오와 프로토파이 커넥트 간의 메시지 Send (보내기) 및 Receive (받기)를 마스터하려면 프로토파이 스쿨의 무료 수업을 확인하세요.

2단계: API 플러그인 내에서 API 설정 구성하기

프로토파이 커넥트에서 프로토타입을 엽니다.
"플러그인"을 클릭한 다음, 목록에서 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의 문서를 주의 깊게 읽어야 합니다.
Test Request 버튼을 클릭하여 연결이 올바르게 작동하고 있는지 확인합니다. 오류 메시지가 나타나면 이전 단계에서 입력한 정보를 검토하세요.

3단계: API를 프로토타입과 연결하기

Message From Pie 입력 필드를 클릭하여 사용 가능한 메시지 목록에 액세스합니다. API 플러그인은 프로토타입 내의 메시지를 자동으로 감지합니다. 메시지가 나타나지 않으면 1단계에서 만든 보내기(Send) 응답에서 복사하여 붙여 넣으세요.
프로토타입에서 보낸 메시지의 값으로 API의 URL, 헤더, 본문을 동적으로 재정의해야 하는 경우 Override URL/Header/Body with msg value 를 활성화합니다. 메시지 값으로 API URL, 헤더, 본문 재정의하기에 대해 자세히 알아보세요.
Message to Pie에 메시지를 입력하세요. 입력된 메시지는 2단계에서 구성한 API 요청에서 얻은 데이터와 함께 프로토타입으로 다시 전송됩니다.
Activate 를 클릭하여 연결을 설정합니다. 프로토타입에서 해당 메시지를 수신하면 플러그인이 API 요청을 시작합니다.

4단계: 프로토파이 스튜디오에서 받기(Receive) 트리거 만들기

프로토파이 스튜디오로 돌아갑니다.
프로토타입에 받기(Receive) 트리거를 추가합니다.
1단계에서 보내기(Send) 응답 설정 시 했던 것과 마찬가지로 ProtoPie Connect/Studio 채널을 선택하는 것을 잊지 마세요.
3단계에서 구성한 것과 동일한 메시지를 Message to Pie아래에 입력합니다.
Assign to Variable 옵션을 활성화합니다. 텍스트 변수를 만들고 받기(Receive) 트리거 목록에서 선택합니다. API에서 얻은 정보는 이제 이 변수에 저장됩니다.
API 데이터는 JSON 형식으로 자주 반환되기 때문에 parseJson 수식과 함께 텍스트(Text) 응답을 사용하여 API 데이터를 프로토타입에 통합하는 방법이 가장 효율적입니다.
프로토타입을 저장한 다음, 프로토파이 커넥트에서 다시 로드합니다. 이제 API 기반 상호작용을 프로토파이 커넥트를 통해 테스트할 준비가 되었습니다!

메시지 값으로 API URL/헤더/본문 재정의하기

Override URL/Header/Body with msg value 는 프로토타입에서 보낸 메시지의 값으로 API의 URL, 헤더, 본문 매개변수를 동적으로 재정의하는 데 사용됩니다.

이 프로토타입 예시에서는 이 기능을 사용하여 파이 파일 내 아래의 보내기(Send) 메시지의 값으로 API URL을 재정의했습니다. 그 결과로 프로토파이 커넥트에서 프로토타입을 테스트하고 검색 상자에 어떤 도시를 입력하면 해당 도시의 정확한 날씨 정보가 표시됩니다.

동시 API 호출 실행하기

Connect Core 와 Connect 엔터프라이즈 사용자는 API 플러그인을 사용하여 여러 API 요청을 동시에 실행할 수 있습니다. 다른 플러그인이 실행 중이 아닌 경우, Connect Core 는 최대 3개의 API 실행이 가능한 반면 Connect 엔터프라이즈 는 동시에 실행할 수 있는 API 호출 수에 제한이 없습니다.

프로토타입에서 여러 API 요청을 동시에 실행하려면 다음과 같은 단계를 따르세요.

프로토파이 커넥트에서 API 플러그인을 엽니다.
API 설정 창의 오른쪽 상단 모서리에 있는 + 아이콘을 클릭합니다. 이렇게 하면 새 창이 열리는데, 그 창에서 추가 API 호출을 구성하고 동시에 실행할 수 있습니다. 기존의 API를 복제하여 원래 설정을 유지할 수도 있습니다.

API 플러그인 입문 자습서

이 입문서 시리즈에서 API 플러그인의 주요 기능과 사용 사례를 알아보세요.