플렉스튜디오에서 공공데이터포털 API 연동 설정하기

플렉스튜디오에서 공공데이터포털 API 연동 설정하기

플렉스튜디오에서 공공데이터포털 데이터를 활용하려면 먼저 API 연동 설정을 진행해야 해요. 이번 글에서는 GET 방식으로 Open API를 설정하는 과정을 소개할게요. 예시로 제로페이 가맹점 목록을 조회하는 앱을 만들어보겠습니다.

👉 플렉스튜디오 유튜브에서 영상 강의 보러 가기

GET 방식 API란?

이번에 사용할 API는 GET 방식이에요. GET 방식은 URL 뒤에 파라미터를 추가해 서버에 정보를 요청하는 방식입니다. 전달 가능한 데이터 양이 제한적이라는 단점이 있습니다. 반대로 간단하고 빠르게 데이터를 가져오는 데 최적화되어 있어 짧고 간단한 데이터 전달에 효율적인 방식이죠.

1단계: API 연동 모듈 만들기

1. API 연동을 위해 플렉스튜디오 워크스페이스 - 좌측 데이터 메뉴 - API 연동 버튼 클릭

2. ‘+’ 버튼을 클릭하여 새로운 API 추가

3. 팝업창에서 빈 템플릿 선택 후 API 명은 자유롭게 입력 (예시 : 가맹점 정보) - 확인 버튼 클릭

4. 생성한 API 이름 옆 더보기 버튼 클릭

5. 새 모듈 버튼을 클릭하여 추가하고 이름은 자유롭게 입력 (예시 : 조회)

6. 모듈 형식은 GET 유지

7. 공공데이터포털에서 발급 받은 Base URL과 엔드포인트를 조합해 요청 URL 입력
   • 추천 방법 : 호출 샘플에서 URL을 복사해 붙여넣는 방식을 사용하면 더 편리해요.

8. URL을 입력하면 파라미터들이 자동 추가
   • 전체 목록을 조회하기 위해 마지막 파라미터 제거 (특정 상호명을 호출하는 CONM_NM 제거)

2단계: 인증키(serviceKey) 등록하기

1. 보안을 위해 인증키(serviceKey)는 Advanced Key Setting - Secret Key 탭에서 설정
   • Secret Key는 클라이언트에서 정보를 확인할 수 없기 때문에 안전하게 사용할 수 있어요.

2. 항목 이름은 APIKEY로 추가하고 발급받은 인코딩된 인증키 등록

3. Params 탭 - serviceKey 항목에는 대체텍스트 표현식을 사용해 입력
   • serviceKey : {=APIKEY}

4. 이미 인코딩된 키를 사용한 경우 URL 인코딩 설정 해제

3단계: 테스트 및 데이터 변환

1. 테스트 탭으로 이동

2. TEST CALL 버튼 클릭

3. ResultBlocks에서 정상적으로 결과값이 호출되는지 확인
   • 호출된 정보를 플렉스튜디오 컬렉션(Collection)과 호환되도록 이중 배결 형식으로 변환

4. 응답 구조를 확인하고 필요한 Body 내부 item값만 남기도록 스크립트 작성
   • 스크립트 작성을 위해 정의 - Script 탭으로 이동
   • 예시 스크립트
     
     if (resultBlocks && resultBlocks[0][0]){
     const items = resultBlocks[0][0].response.body.items
     resultBlocks[0] = items.item || [];
     }
     

5. 다시 테스트하여 afterScript ResultBlocks에서 정돈된 데이터가 잘 출력되는지 확인

6. 모든 설정이 완료되었으면 우측 하단 배포 버튼 클릭

다음 강의: 시나리오에서 공공데이터포털 API 데이터 활용하기

이번 강의에서는 플렉스튜디오에서 API 연동 설정을 위해 모듈을 추가했어요.
다음 강의에서는 시나리오에서 API 데이터를 사용하는지 단계별로 설명해 드릴게요.